Skip to content

Commit

Permalink
improved README with install instructions and pypi info
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Aug 25, 2014
1 parent 6c744f5 commit c5bcb33
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/djangonauts/django-hstore>`__.

This code was originally written for `Nodeshot <https://github.com/ninuxorg/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
Expand All @@ -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
Expand Down

0 comments on commit c5bcb33

Please sign in to comment.