Add screenshot

hotwire-django · Jan 9, 2021 · ebbba58 · ebbba58
1 parent 7993cd0
commit ebbba58
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,9 +4,17 @@ What is this ?
 Alabaster Hotwire is a fork of [Alabaster](http://alabaster.readthedocs.io), the default Sphinx theme,
 quickly modified (hacked ?) to follow the same style as [Hotwire.dev](https://hotwire.dev).
 
+![Screenshot](screenshot.png)
+
 How to use it for Django Hotwire projects ?
 ===========================================
 
+Add the theme to the documentation requirements.txt (along Sphinx)
+
+```
+git+https://github.com/hotwire-django/sphinx-hotwire-theme.git
+```
+
 Change the theme in the `conf.py` file
 ```python
 html_theme = "alabaster_hotwire"

diff --git a/screenshot.png b/screenshot.png