diff options
| author | Tom Christie | 2012-12-27 17:53:07 +0000 | 
|---|---|---|
| committer | Tom Christie | 2012-12-27 17:53:07 +0000 | 
| commit | 4b32cda5a8a32bf43e80dfbe6d9d17a07b20152c (patch) | |
| tree | 976cc8ce53240dd7dc8e402a890e60f8cab9aab9 /docs/index.md | |
| parent | 9cc56a97b55e183d8131665d1409649379a969f0 (diff) | |
| download | django-rest-framework-4b32cda5a8a32bf43e80dfbe6d9d17a07b20152c.tar.bz2 | |
Update release notes and documentation for 2.2.0
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 19 | 
1 files changed, 15 insertions, 4 deletions
diff --git a/docs/index.md b/docs/index.md index cc0f2a13..5d90e9e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ Django REST framework is a lightweight library that makes it easy to build Web A  Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers.  It also supports a wide range of media types, authentication and permission policies out of the box. -If you are considering using REST framework for your API, we recommend reading the [REST framework 2 announcment][rest-framework-2-announcement] which gives a good overview of the framework and it's capabilities. +If you are considering using REST framework for your API, we recommend reading the [REST framework 2 announcement][rest-framework-2-announcement] which gives a good overview of the framework and it's capabilities.  There is also a sandbox API you can use for testing purposes, [available here][sandbox]. @@ -52,21 +52,32 @@ Install using `pip`, including any optional packages you want...      pip install -r requirements.txt      pip install -r optionals.txt -Add `rest_framework` to your `INSTALLED_APPS`. +Add `'rest_framework'` to your `INSTALLED_APPS` setting.      INSTALLED_APPS = (          ...          'rest_framework',              ) -If you're intending to use the browseable API you'll want to add REST framework's login and logout views.  Add the following to your root `urls.py` file. +### Browseable API requirements + +If you're intending to use the browseable API you'll also want to also ensure you include `'django.contrib.staticfiles'` in your `INSTALLED_APPS` setting. + +    INSTALLED_APPS = ( +        ... +        'django.contrib.staticfiles', +        'rest_framework', +    ) + +You'll proabably also want to add REST framework's login and logout views. +Add the following to your root `urls.py` file.      urlpatterns = patterns('',          ...          url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))      ) -Note that the URL path can be whatever you want, but you must include `rest_framework.urls` with the `rest_framework` namespace. +Note that the URL path can be whatever you want, but you must include `'rest_framework.urls'` with the `'rest_framework'` namespace.  ## Quickstart  | 
