From 2a69b68fe50470d0f792f4922f1e399eec6beb0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Kurzeja?= Date: Tue, 31 Oct 2017 19:04:47 +0100 Subject: [PATCH] Add installation instructions --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index aa6f4dc..ff3498b 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,23 @@ Yet another approach to provide soft (logical) delete or masking (thrashing) dja .. image:: https://api.travis-ci.org/meteozond/django-permanent.svg?branch=master +Installation +============ + +Download the package using pip: + +.. code-block:: python + + pip install django_permanent + +Add ``django_permanent`` to ``INSTALLED_APPS`` in project settings: + +.. code-block:: python + + INSTALLED_APPS += 'django_permanent' + +From now on you can import ``PermanentModel`` in your models. + Models ================