diff --git a/README.rst b/README.rst index f415ee7..b09c2ac 100644 --- a/README.rst +++ b/README.rst @@ -3,14 +3,15 @@ .. image:: https://badge.fury.io/py/django-hashid-field.svg :target: https://badge.fury.io/py/django-hashid-field -Django Hashid Field -==================== +WARNING! This module is retired! +================================ -.. warning:: +**This library has been retired. It is no longer recommended for new projects. Existing projects do not require +changes, but should consider migrating to a different library. See the [RETIRED](RETIRED.md) document for more +information.** - This library has been retired. It is no longer recommended for new projects. Existing projects do not require - changes, but should consider migrating to a different library. See the [RETIRED](RETIRED.md) document for more - information. +Django Hashid Field +==================== A custom Model Field that uses the `Hashids `_ `library `_ to obfuscate an IntegerField or AutoField. It can be used in new models or dropped in place of an existing IntegerField,