Add extra "sanitize" (#10)

matthiask · Jul 30, 2024 · 81da3f2 · 81da3f2
1 parent 5e3df46
commit 81da3f2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -26,6 +26,13 @@ Install the package:
 
     venv/bin/pip install django-prose-editor
 
+To include nh3 as optional dependency for sanitized HTML, install the extra
+"sanitize": 
+
+.. code-block:: shell
+
+    venv/bin/pip install django-prose-editor[sanitize]
+
 Add ``django_prose_editor`` to ``INSTALLED_APPS``:
 
 .. code-block:: python
@@ -65,6 +72,8 @@ snippet to always pass HTML through `nh3
 
     description = SanitizedProseEditorField()
 
+Install django-prose-editor with the extra "sanitize" to use
+``SanitizedProseEditorField``.
 
 Convenience
 ~~~~~~~~~~~

diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,9 @@ optional-dependencies.tests = [
   "coverage",
   "nh3",
 ]
+optional-dependencies.sanitize = [
+  "nh3",
+]
 urls.Homepage = "https://github.com/matthiask/django-prose-editor/"
 
 [tool.hatch.build]