diff options
| author | José Padilla | 2014-11-28 12:14:40 -0400 | 
|---|---|---|
| committer | José Padilla | 2014-11-28 12:14:40 -0400 | 
| commit | 0cc990792c63caa8fa8fea62cea53b0d28157b55 (patch) | |
| tree | 7ea80a203cc8718150cd55e4403f3f4771160281 /docs/index.md | |
| parent | 1aa77830955dcdf829f65a9001b6b8900dfc8755 (diff) | |
| parent | 3a5b3772fefc3c2f2c0899947cbc07bfe6e6b5d2 (diff) | |
| download | django-rest-framework-0cc990792c63caa8fa8fea62cea53b0d28157b55.tar.bz2 | |
Merge branch 'version-3.1' into oauth_as_package
Conflicts:
	requirements-test.txt
	rest_framework/compat.py
	tests/settings.py
	tox.ini
Diffstat (limited to 'docs/index.md')
| -rw-r--r-- | docs/index.md | 19 | 
1 files changed, 10 insertions, 9 deletions
| diff --git a/docs/index.md b/docs/index.md index 7e6f520c..dc7bb6d0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,10 @@  --- +**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available. + +--- +  <p>  <h1 style="position: absolute;      width: 1px; @@ -22,9 +26,6 @@  <img alt="Django REST Framework" title="Logo by Jake 'Sid' Smith" src="img/logo.png" width="600px" style="display: block; margin: 0 auto 0 auto">  </p> -<!-- -# Django REST framework --->  Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs. @@ -43,14 +44,12 @@ Some reasons you might want to use REST framework:  **Above**: *Screenshot from the browsable API* ----- -  ## Requirements  REST framework requires the following: -* Python (2.6.5+, 2.7, 3.2, 3.3) -* Django (1.4.2+, 1.5, 1.6, 1.7) +* Python (2.6.5+, 2.7, 3.2, 3.3, 3.4) +* Django (1.4.11+, 1.5.5+, 1.6, 1.7)  The following packages are optional: @@ -82,10 +81,10 @@ Add `'rest_framework'` to your `INSTALLED_APPS` setting.  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('', +    urlpatterns = [          ...          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. @@ -170,6 +169,7 @@ The API guide is your complete reference manual to all the functionality provide  * [Serializers][serializers]  * [Serializer fields][fields]  * [Serializer relations][relations] +* [Validators][validators]  * [Authentication][authentication]  * [Permissions][permissions]  * [Throttling][throttling] @@ -289,6 +289,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  [serializers]: api-guide/serializers.md  [fields]: api-guide/fields.md  [relations]: api-guide/relations.md +[validators]: api-guide/validators.md  [authentication]: api-guide/authentication.md  [permissions]: api-guide/permissions.md  [throttling]: api-guide/throttling.md | 
