Commit ddc8c303 by Tom Christie

Cleaner documentation around installation of optional packages

parent 0ef6b1c1
...@@ -19,20 +19,24 @@ REST framework requires the following: ...@@ -19,20 +19,24 @@ REST framework requires the following:
The following packages are optional: 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 self describing API.
* [PyYAML][yaml] (3.10+) - YAML content type support. * [PyYAML][yaml] (3.10+) - YAML content-type support.
## Installation ## Installation
**WARNING: These instructions will only become valid once this becomes the master version** **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 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. ...or clone the project from github.
git clone git@github.com:tomchristie/django-rest-framework.git git clone git@github.com:tomchristie/django-rest-framework.git
cd django-rest-framework
pip install -r requirements.txt pip install -r requirements.txt
pip install -r optionals.txt
Add `djangorestframework` to your `INSTALLED_APPS`. Add `djangorestframework` to your `INSTALLED_APPS`.
......
markdown>=2.1.0
PyYAML>=3.10
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment