aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorTom Christie2013-04-30 09:38:04 +0100
committerTom Christie2013-04-30 09:38:04 +0100
commit455d7cca1e70fad9f73dffe3fb6d63a44330eae5 (patch)
treeaa1ef6589a98f493196e5d1dddeb6a603a21af2b /docs/index.md
parentd0ba48b5c0c2ba08b20ec17490c0847b4e27405e (diff)
downloaddjango-rest-framework-455d7cca1e70fad9f73dffe3fb6d63a44330eae5.tar.bz2
More tweaking of index/readme
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/index.md b/docs/index.md
index 19ed5a98..ec8b4bae 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -11,13 +11,17 @@
**Awesome web-browseable Web APIs.**
-Django REST framework is a flexible and powerful Web API toolkit. It is designed as a modular and easy to customize architecture, based on Django's class based views.
+Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs.
-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.
+Some reasons you might want to use REST framework:
-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.
+* The Web browseable API is a huge useability win for your developers.
+* Authentication policies including OAuth1a and OAuth2 out of the box.
+* Serialization that supports both ORM and non-ORM data sources.
+* Customizable all the way down. Just use regular function-based views if you don't need the more powerful features.
+* Extensive documentation, and great community support.
-There is also a sandbox API you can use for testing purposes, [available here][sandbox].
+There is a live example API for testing purposes, [available here][sandbox].
**Below**: *Screenshot from the browseable API*
@@ -52,9 +56,6 @@ Install using `pip`, including any optional packages you want...
...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 `'rest_framework'` to your `INSTALLED_APPS` setting.