Release 1.0.0 (#86)

* chore: update docs for django 2.2 config * chore: bump version to 1.0.0
jazzband · Oct 21, 2021 · 4490cdf · 4490cdf
1 parent 068db31
commit 4490cdf
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -85,23 +85,35 @@ In some use-cases, JSONB (binary JSON data) datatype (Postgres 9.4+ and analogou
 
 ## Installation
 
-You can install **django-eav2** from three sources:
+Install with pip
 
 ```bash
-# From PyPI via pip
 pip install django-eav2
+```
+
+## Configuration
+
+Add `eav2` to `INSTALLED_APPS` in your settings.
+
+```python
+INSTALLED_APPS = [
+    ...
+    'eav',
+]
+```
+
+### Note: Django 2.2 Users
 
-# From source via pip
-pip install git+https://github.com/lvm/django-eav2@master
+Since `models.JSONField()` isn't supported in Django 2.2, we use [django-jsonfield-backport](https://github.com/laymonage/django-jsonfield-backport) to provide [JSONField](https://docs.djangoproject.com/en/dev/releases/3.1/#jsonfield-for-all-supported-database-backends) functionality.
 
-# From source via setuptools
-git clone git@github.com:lvm/django-eav2.git
-cd django-eav2
-python setup.py install
+This requires adding `django_jsonfield_backport` to your `INSTALLED_APPS` as well.
 
-# To uninstall:
-python setup.py install --record files.txt
-rm $(cat files.txt)
+```python
+INSTALLED_APPS = [
+    ...
+    'eav',
+    'django_jsonfield_backport',
+]
 ```
 
 ## Getting started

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -3,43 +3,35 @@ Getting Started
 
 Installation
 ------------
-
-You can install **django-eav2** from PyPI, git or directly from source:
-
-From PyPI
-^^^^^^^^^
 ::
 
     pip install django-eav2
 
-With pip via git
-^^^^^^^^^^^^^^^^
-::
-
-    pip install git+https://github.com/lvm/django-eav2@master
+Configuration
+-------------
 
-From source
-^^^^^^^^^^^
+After you've installed the package, you have to add it to your Django apps
 ::
 
-    git clone git@github.com:lvm/django-eav2.git
-    cd django-eav2
-    python setup.py install
+    INSTALLED_APPS = [
+        ...
+        'eav',
+    ]
 
-To uninstall::
+Note: Django 2.2 Users
+^^^^^^^^^^^^^^^^^^^^^^
 
-    python setup.py install --record files.txt
-    rm $(cat files.txt)
+Since ``models.JSONField()`` isn't supported in Django 2.2, we use `django-jsonfield-backport <https://github.com/laymonage/django-jsonfield-backport>`_
+ to provide `JSONField <https://docs.djangoproject.com/en/dev/releases/3.1/#jsonfield-for-all-supported-database-backends>`_
+ functionality.
 
-Configuration
--------------
+This requires adding ``django_jsonfield_backport`` to your INSTALLED_APPS as well.
 
-After you've installed the package, you have to add it to your Django apps::
 
-    INSTALLED_APPS = [
-        # ...
+::
 
+    INSTALLED_APPS = [
+        ...
         'eav',
-
-        # ...
+        'django_jsonfield_backport',
     ]
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -16,7 +16,7 @@ include = '\.pyi?$'
 [tool.poetry]
 name = "django-eav2"
 description = "Entity-Attribute-Value storage for Django"
-version = "0.14.1"
+version = "1.0.0"
 license = "GNU Lesser General Public License (LGPL), Version 3"
 packages = [
   { include = "eav" }
@@ -55,7 +55,7 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.6.2"
+python = "^3.6"
 django-jsonfield-backport = "^1.0.4"
 
 [tool.poetry.dev-dependencies]