Feature/1 doc

README.md

@@ -1 +1,14 @@
-# README
+<div align="center">
+
+<h1>Django Lookbook</h1>
+
+<p>Empower your Django development with this pluggable app for creating a robust component library. Includes preview system, documentation engine, and parameter editor for building modular UI effortlessly.</p>
+
+<p><strong><a href="https://django-lookbook.readthedocs.io/en/latest/">Documentation</a> &nbsp;|&nbsp; <a href="https://saashammer.com/lookbook/">Demo site</a></strong></p>
+
+<p><a href="https://pypi.org/project/django-lookbook/"><img src="https://badge.fury.io/py/django-lookbook.svg" alt="Pypi version"></a>
+<a href="https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml"><img src="https://github.com/rails-inspire-django/django-lookbook/actions/workflows/runtests.yml/badge.svg" alt="CI status"></a></p>
+
+</div>
+
+![Django Lookbook UI](.github/assets/lookbook_ui.png)

docs/source/conf.py

@@ -61,3 +61,16 @@ def _get_version() -> str:
 # html_static_path = ['_static']
 html_theme = "furo"
 pygments_style = "sphinx"
+
+announcement_html = """
+<div class="">
+  Have questions, feedback, or just want to chat? Reach out to me on
+  <a href="https://twitter.com/michaelyinplus" target="_blank">
+    <strong>Twitter / X</strong>
+  </a>
+</div>
+"""
+
+html_theme_options = {
+    "announcement": announcement_html,
+}

docs/source/install.md

@@ -97,7 +97,7 @@ Each time we visit a preview, the method would be called and the final result wo
 
 ## Override Template
 
-In some cases, you might need to render HTML code which need work with CSS and JS. You can override the `preview` template to include them.
+In some cases, you might need to render HTML code which need work with your own CSS and JS. You can override the `preview` template to include them.
 
 Create *django_viewcomponent/preview.html* in the project `templates` directory