aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2012-11-09 16:44:39 +0000
committerTom Christie2012-11-09 16:44:39 +0000
commitd365621cbeb333d857dd312147edd5cd076866e8 (patch)
treeb5ea1dcd50418a034509651f970e7718337f98e7
parent9aaeeacdfebc244850e82469e4af45af252cca4d (diff)
downloaddjango-rest-framework-d365621cbeb333d857dd312147edd5cd076866e8.tar.bz2
Note django-filter installation
-rw-r--r--docs/index.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/index.md b/docs/index.md
index 1874ec00..fd834540 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -32,7 +32,7 @@ REST framework requires the following:
The following packages are optional:
-* [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API.
+* [Markdown][markdown] (2.1.0+) - Markdown support for the browseable API.
* [PyYAML][yaml] (3.10+) - YAML content-type support.
* [django-filter][django-filter] (master) - Filtering support.
@@ -41,8 +41,9 @@ The following packages are optional:
Install using `pip`, including any optional packages you want...
pip install djangorestframework
- pip install markdown # Recommended if using the browseable API.
- pip install pyyaml # Required for yaml content-type support.
+ pip install markdown # Markdown support for the browseable API.
+ pip install pyyaml # YAML content-type support.
+ pip install -e git+https://github.com/alex/django-filter.git#egg=django-filter # Filtering support
...or clone the project from github.