aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorVictor Shih2013-05-01 21:26:40 -0700
committerVictor Shih2013-05-01 21:26:40 -0700
commit8cabae22c5330da2e0a15a6d61ef038a6447756a (patch)
treefbebe8abad45c92f9dc0d3bb87b1d1ecbbdeeb61 /docs/index.md
parent198b679e02954ebcfac37e9d0146caf575df4f5a (diff)
downloaddjango-rest-framework-8cabae22c5330da2e0a15a6d61ef038a6447756a.tar.bz2
Example and spelling fixes. Change "browseable" to "browsable" for consistency.
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/index.md b/docs/index.md
index 4c2720c8..377da54c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -9,17 +9,17 @@
# Django REST framework
-**Awesome web-browseable Web APIs.**
+**Awesome web-browsable Web APIs.**
Django REST framework is a flexible, powerful Web API toolkit. It is designed as a modular and easy to customize architecture, based on Django's class based views.
-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.
+APIs built using REST framework are fully self-describing and web browsable - 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 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].
-**Below**: *Screenshot from the browseable API*
+**Below**: *Screenshot from the browsable API*
![Screenshot][image]
@@ -32,7 +32,7 @@ REST framework requires the following:
The following packages are optional:
-* [Markdown][markdown] (2.1.0+) - Markdown support for the browseable API.
+* [Markdown][markdown] (2.1.0+) - Markdown support for the browsable API.
* [PyYAML][yaml] (3.10+) - YAML content-type support.
* [defusedxml][defusedxml] (0.3+) - XML content-type support.
* [django-filter][django-filter] (0.5.4+) - Filtering support.
@@ -46,7 +46,7 @@ The following packages are optional:
Install using `pip`, including any optional packages you want...
pip install djangorestframework
- pip install markdown # Markdown support for the browseable API.
+ pip install markdown # Markdown support for the browsable API.
pip install pyyaml # YAML content-type support.
pip install django-filter # Filtering support
@@ -64,7 +64,7 @@ Add `'rest_framework'` to your `INSTALLED_APPS` setting.
'rest_framework',
)
-If you're intending to use the browseable API you'll probably also want to add REST framework's login and logout views. Add the following to your root `urls.py` file.
+If you're intending to use the browsable API you'll probably also want to add REST framework's login and logout views. Add the following to your root `urls.py` file.
urlpatterns = patterns('',
...