Merge pull request #144 from benjaoming/bump-1.4

Bump to 1.4

Author: benjaoming

README.rst

@@ -8,8 +8,8 @@ django-nyt
    :alt: Documentation Status
 .. image:: https://badge.fury.io/py/django-nyt.svg
    :target: https://pypi.org/project/django-nyt/
-.. image:: https://codecov.io/github/django-wiki/django-nyt/coverage.svg?branch=master
-  :target: https://app.codecov.io/github/django-wiki/django-nyt?branch=master
+.. image:: https://codecov.io/github/django-wiki/django-nyt/coverage.svg?branch=main
+   :target: https://app.codecov.io/github/django-wiki/django-nyt?branch=main
 
 Concept
 -------
@@ -23,14 +23,12 @@ django-nyt is a notification framework for Django. It does this:
     EVENT_KEY = "my_key"
     notify(_("OMG! Something happened"), EVENT_KEY)
 
-All users subscribing to ``"my_key"`` will have a notification created
-in their stack when ``notify()`` is called.
+All users subscribing to ``"my_key"`` will have a notification created when ``notify()`` is called.
+How the notification is handled depends on the user's settings.
 
-If you have emails enabled, subscribers receive a summary of notifications at
-an interval of their choice.
+If you have emails enabled, subscribers receive a summary of notifications immediately or at an interval of their choice.
 
-Data can be accessed easily from Django models or from the included JSON
-views.
+Data can be accessed easily from Django models or from the included JSON views.
 
 By using generic object relations, custom URLs, and custom email templates,
 you can expand your notification logic to create email messages that both marks the notification as read when clicking a link and at the same time redirects users to a final destination:
@@ -49,11 +47,16 @@ you can expand your notification logic to create email messages that both marks
     )
 
 
-Channels (django-channels)
---------------------------
+Roadmap
+-------
+
+This project makes sense if people start using it and maturing it to their use-cases.
+
+Here are some aspects that aren't covered but are most welcome:
 
-Starting from django-nyt 1.0, support for
-`channels <https://channels.readthedocs.io/en/stable/>`_ 1.0 has been added.
+* Support for async
+* Support for notifications through django-channels 4+
+* Support for HTML emails (and user setting)
 
 Docs
 ----

django_nyt/__init__.py

@@ -1,5 +1,5 @@
 _disable_notifications = False
 
-__version__ = "1.4rc5"
+__version__ = "1.4"
 
 default_app_config = "django_nyt.apps.DjangoNytConfig"

docs/release_notes.rst

@@ -1,9 +1,17 @@
 Release Notes
 =============
 
-1.4 (unreleased)
+1.4 (2024-02-16)
 ----------------
 
+Hello 👋️ We're alive and maintaining this!
+
+This release puts django-nyt a step forwards toward being a mature framework, especially by adding Django 5 support, fixing issues and adding more tests.
+However, there are still some async capabilities remaining to be solved for it to be both mature and modern.
+
+If you can get behind :doc:`the concept </index>`, please consider the great potential of contributing to this project!
+
+
 **Added**
 
 * Custom email templates per notification type:
@@ -44,16 +52,16 @@ Release Notes
 * Python 3.7 support removed #129 (Benjamin Balder Bach)
 * Unused (!) setting ``NYT_ENABLED`` was removed #134 (Benjamin Balder Bach)
 
-1.3
----
+1.3 (2023-05-03)
+----------------
 
 * Hatch build system, environment management and more #116 (Oscar Cortez)
 * pre-commit configuration updated #116 (Oscar Cortez)
 * Code-base black'ned #116 (Oscar Cortez)
 
 
-1.2.4
------
+1.2.4 (2022-11-11)
+------------------
 
 * Adds Django 4.1 support #113 (Oscar Cortez)