From c5bcb33464fc01516d5ba903f8252483ccd3ddde Mon Sep 17 00:00:00 2001 From: Federico Capoano Date: Mon, 25 Aug 2014 12:05:57 +0200 Subject: [PATCH] improved README with install instructions and pypi info --- README.rst | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index a4f8dd9..e72f210 100755 --- a/README.rst +++ b/README.rst @@ -15,17 +15,27 @@ Django Rest Framework HStore :target: https://requires.io/github/djangonauts/django-rest-framework-hstore/requirements/?branch=master :alt: Requirements Status +.. image:: https://badge.fury.io/py/djangorestframework-hstore.png + :target: http://badge.fury.io/py/djangorestframework-hstore + ------------ -Serializer field for django-hstore. +Django Rest Framework tools for `django-hstore `__. This code was originally written for `Nodeshot `__ and then extracted into this generic python package. -HStoreField -=========== +Install +======= + +.. code-block:: bash -Not sufficient to support schema mode. + pip install djangorestframework-hstore + +HStoreField Usage +================= + +This field is not sufficient to support **django-hstore** ``schema-mode``. .. code-block:: python @@ -42,10 +52,12 @@ Not sufficient to support schema mode. model = MyModel -HStoreSerializer -================ +HStoreSerializer Usage +====================== + +Supports **django-hstore** ``DictionaryField`` and ``schema-mode`` out of the box. -Supports ``DictionaryField`` and schema mode out of the box. +Prefer this to ``HStoreField``. .. code-block:: python