chore: updated docs

jazzband · Oct 18, 2024 · e16485c · e16485c
1 parent 3c8aed8
commit e16485c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,9 @@
+0.13.0 (Unreleased)
+===================
+
+* Added new `REVPROXY_QUOTE_SPACES_AS_PLUS` setting
+
+
 0.12.0 (2023-10-19)
 ===================
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,7 @@ Contents:
    quickstart
    proxyview
    modules
+   settings
    changelog
 
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -27,7 +27,7 @@ Start by adding revproxy to your ``settings.py`` file as follows:
     INSTALLED_APPS = (
         # ...
         'django.contrib.auth',
-        'revproxy',
+        'revproxy.apps.RevProxyConfig',
         # ...
     )
 

diff --git a/docs/settings.rst b/docs/settings.rst
@@ -0,0 +1,4 @@
+Settings
+==================
+
+`REVPROXY_QUOTE_SPACES_AS_PLUS`: Tells revproxy if it spaces should be replaced by `+` or `%20`.
diff --git a/revproxy/settings.py b/revproxy/settings.py
@@ -1,3 +1,3 @@
 REVPROXY_DEFAULT_SETTINGS = {
-    'QUOTE_SPACES_AS_PLUS': True,
+    'REVPROXY_QUOTE_SPACES_AS_PLUS': True,
 }