aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorTom Christie2012-09-03 12:11:57 +0100
committerTom Christie2012-09-03 12:11:57 +0100
commitddc8c30317708ed7e23d629b8531a27a80a97cb4 (patch)
tree21692dea85e914b67eda979ce623477b753772f8 /docs/index.md
parent0ef6b1c122b0f5c3cc195b44a06671aefa75c9f7 (diff)
downloaddjango-rest-framework-ddc8c30317708ed7e23d629b8531a27a80a97cb4.tar.bz2
Cleaner documentation around installation of optional packages
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/index.md b/docs/index.md
index 31bb9deb..25cab398 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -19,20 +19,24 @@ REST framework requires the following:
The following packages are optional:
* [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API.
-* [PyYAML][yaml] (3.10+) - YAML content type support.
+* [PyYAML][yaml] (3.10+) - YAML content-type support.
## Installation
**WARNING: These instructions will only become valid once this becomes the master version**
-Install using `pip`...
+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.
...or clone the project from github.
git clone git@github.com:tomchristie/django-rest-framework.git
+ cd django-rest-framework
pip install -r requirements.txt
+ pip install -r optionals.txt
Add `djangorestframework` to your `INSTALLED_APPS`.