update README, change to docs dir

rails-inspire-django · Nov 1, 2023 · f5d6be4 · f5d6be4
1 parent f16639d
commit f5d6be4
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 32 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@
 *.egg
 *.egg-info
 
-doc/build
+docs/build
 dist
 build
 
@@ -19,7 +19,7 @@ __pycache__
 .pytest_cache/
 .vscode/
 .coverage
-doc/build
+docs/build
 
 node_modules/
 

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: doc/source/conf.py
+  configuration: docs/source/conf.py
 
 # Build documentation with MkDocs
 #mkdocs:
@@ -19,6 +19,6 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
+  version: 3.10
   install:
-    - requirements: doc/requirements.txt
+    - requirements: docs/requirements.txt
diff --git a/README.md b/README.md
@@ -1,32 +1,9 @@
-This package provides helpers for server-side rendering of [Hotwired/Turbo](https://hotwired.dev/) streams and frames.
+This package provides helpers for server-side rendering of `Turbo Frame` and `Turbo Stream`, which aim to work with the [Hotwire](https://hotwire.dev/) project.
 
-**Disclaimer**: the Hotwired/Turbo client libraries are, at time of writing, still in Beta. We expect there will be breaking changes until the first stable release. This package, and the Turbo client, should therefore be used with caution in a production environment. The version used in testing is *@hotwired/turbo==7.0.0-beta.8*.
-
-
-## Requirements
-
-This library requires Python 3.8+ and Django 3.0+.
-
-## Installation
-
-> pip install django-turbo-response
-
-To install from Git:
-
-> git clone https://github.com/hotwire-django/django-turbo-response
-
-> cd django-turbo-response
-
-> python setup.py install
-
-Make sure to add *turbo_response* to **INSTALLED_APPS**.
-
-**Note**: This library does not include any client libraries (Turbo or Stimulus). You may wish to add these yourself using your preferred Javascript build tool, or use a CDN. Please refer to the Hotwire documentation on installing these libraries.
-
-Full documentation on ReadTheDocs:
+## Documentation
 
 https://django-turbo-response.readthedocs.io/en/latest/
 
-## License
+## Free Hotwire Django eBook
 
-This project is covered by the MIT license.
+If you are new to Hotwire, you may be interested in this free eBook to learn it [Hotwire Django: The Missing Guide](https://hotwire-django.com/).
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/make.bat → docs/make.bat b/doc/make.bat → docs/make.bat
diff --git a/doc/requirements.txt → docs/requirements.txt b/doc/requirements.txt → docs/requirements.txt
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
diff --git a/doc/source/main.md → docs/source/main.md b/doc/source/main.md → docs/source/main.md