summaryrefslogtreecommitdiff
path: root/jinja2-compat/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'jinja2-compat/README.rst')
-rw-r--r--jinja2-compat/README.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/jinja2-compat/README.rst b/jinja2-compat/README.rst
new file mode 100644
index 0000000..b240416
--- /dev/null
+++ b/jinja2-compat/README.rst
@@ -0,0 +1,9 @@
+The Jinja2 package has been renamed to `Jinja`_. This package provides
+compatibility while projects transition to the new name. Imports from
+``jinja2`` will be redirected to ``jinja`` and a deprecation warning
+will be emitted.
+
+Projects are advised to require 'Jinja' instead of 'Jinja2' and replace
+all imports of ``jinja2`` with ``jinja`` to continue receiving updates.
+
+.. _Jinja: https://pypi.org/project/Jinja/