From 1832529f3903e49c89219ad509e5f984eb43abd8 Mon Sep 17 00:00:00 2001 From: Vasil Slavov Date: Thu, 4 Feb 2021 16:44:11 +0200 Subject: [PATCH] Add info about upgrading to Django 3 in the README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2b6aca5..b384af9 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ A custom Django choice field to use with [Python enums.](https://docs.python.org [![PyPI version](https://badge.fury.io/py/django-enum-choices.svg)](https://badge.fury.io/py/django-enum-choices) + +**Important Note: Django 3 has introduced it's own enumeration types: https://docs.djangoproject.com/en/3.1/ref/models/fields/#enumeration-types** + +**This makes `django-enum-choices` redundant when used with Django >= `3.0`.** + +**If you are using `django-enum-choices` and you want to upgrade your project to Django >= `3.0` you can refer to the guide in the wiki: [Migrating to Django 3](https://github.com/HackSoftware/django-enum-choices/wiki/Migrating-to-Django-3)** + +**We will continue to support the compatibility with Django's versions prior to `3.0`.** + + ## Table of Contents - [django-enum-choices](#django-enum-choices)