docs: add deprecation notice (#546)

browniebroke · Nov 28, 2023 · 2f339a4 · 2f339a4
1 parent 7b310b2
commit 2f339a4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -41,12 +41,13 @@
 
 ---
 
+> [!IMPORTANT]
+> The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.
+
 **django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a minimal [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms.
 
 This version **does not** include any static files, it's using the TinyMCE from the CDN by default.
 
-**Warning**: TinyMCE 4 is incompatible with TinyMCE 3. Read [TinyMCE](https://www.tinymce.com/) docs for more information about how to configure TimyMCE 4 editor widget.
-
 ## Compatibility
 
 - **Python**: 3.8-3.12

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,9 @@
 # Welcome to django-tinymce4-widget documentation!
 
+```{warning}
+The latest version of TinyMCE (at time of writing) is version 6. This package is -and will stay- focused on TinyMCE 4 only. I no longer use this package myself so I have no incentive to keep it up to date. I recommend moving to a maintained alternative like [Jazzband](https://github.com/jazzband/django-tinymce) or alternatively fork it.
+```
+
 **django-tinymce4-widget** is a reworked fork of [django-tinymce4-lite](https://github.com/romanvm/django-tinymce4-lite). It provides a [TinyMCE 4](https://www.tinymce.com/) editor widget that can be used in Django forms and models.
 
 The main difference with the original fork is that it **does not** include any static files, it's using the TinyMCE from the CDN by default.