From f5d6be4e963bdc2b9e173b3cd4a8b4f88a5c72ec Mon Sep 17 00:00:00 2001 From: Michaelyin Date: Wed, 1 Nov 2023 16:01:08 +0800 Subject: [PATCH] update README, change to docs dir --- .gitignore | 4 ++-- .readthedocs.yaml | 6 +++--- README.md | 31 ++++--------------------------- {doc => docs}/Makefile | 0 {doc => docs}/make.bat | 0 {doc => docs}/requirements.txt | 0 {doc => docs}/source/conf.py | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/main.md | 0 9 files changed, 9 insertions(+), 32 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/requirements.txt (100%) rename {doc => docs}/source/conf.py (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/main.md (100%) diff --git a/.gitignore b/.gitignore index e5bafa1..2b874d6 100644 --- 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 index b556273..ce298d7 100644 --- 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 index 53a4b3f..4cb37d7 100644 --- 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 b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/requirements.txt b/docs/requirements.txt similarity index 100% rename from doc/requirements.txt rename to docs/requirements.txt diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/main.md b/docs/source/main.md similarity index 100% rename from doc/source/main.md rename to docs/source/main.md