From 6558a20d6bfeb161c4818414e8212ca7a210b3cf Mon Sep 17 00:00:00 2001 From: Jason Kraus Date: Thu, 11 Apr 2013 11:23:58 -0700 Subject: [PATCH] updated docs --- README.rst | 3 ++- doc_requirements.txt | 1 + docs/source/manual/content_types.rst | 6 ++++++ docs/source/manual/installation.rst | 1 + requirements.txt | 2 +- 5 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 98851c6..85c1cbf 100644 --- a/README.rst +++ b/README.rst @@ -28,7 +28,7 @@ Features Supported Media Formats: * application/text-html, text/html - provides HTML responses -* application/json - plain json serialization +* application/json - plain json serialization, uses datataps * text/javascript - for jsonp * application/vnd.Collection+JSON * application/vnd.Collection.next+JSON @@ -43,6 +43,7 @@ Requirements * Python 2.6 or later * Django 1.3 or later +* django-datatap =============== diff --git a/doc_requirements.txt b/doc_requirements.txt index 6579eec..24a785b 100644 --- a/doc_requirements.txt +++ b/doc_requirements.txt @@ -1,3 +1,4 @@ mimeparse django>=1.4 +django-datatap diff --git a/docs/source/manual/content_types.rst b/docs/source/manual/content_types.rst index 686916f..fb9ae08 100644 --- a/docs/source/manual/content_types.rst +++ b/docs/source/manual/content_types.rst @@ -2,6 +2,12 @@ Content Types ============= +Hyperadmin supports 3 different modes of content types: + +* HTML - renders a response using the django template engine +* Hypermedia - renders a structured response representing a workflow and data (ie application/vnd.collection+json) +* Datatap - renders and loads fixtures (ie application/json) + Media Type Selection ==================== diff --git a/docs/source/manual/installation.rst b/docs/source/manual/installation.rst index 2f92706..6714345 100644 --- a/docs/source/manual/installation.rst +++ b/docs/source/manual/installation.rst @@ -7,6 +7,7 @@ Requirements * Python 2.6 or later * Django 1.3 or later +* django-datatap -------- Settings diff --git a/requirements.txt b/requirements.txt index db24b66..321a447 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ mimeparse #django>=1.3 --e git+git://github.com/zbyte64/django-datatap.git#egg=django-datatap +django-datatap