diff --git a/README.md b/README.md index 76d06f8..395560f 100644 --- 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 new file mode 100644 index 0000000..7a48307 Binary files /dev/null and b/screenshot.png differ