Commits

Anonymous committed 8fd6d79

Minor doc tweaks

  • Participants
  • Parent commits 3058329

Comments (0)

Files changed (1)

File docs/index.rst

 .. meta::
    :description: A lightweight REST framework for Django.
-   :keywords: django, python, REST, RESTful
+   :keywords: django, python, REST, RESTful, API, interface, framework
 
 
 Django REST framework
 Introduction
 ------------
 
-Django REST framework aims to make it easy to build well-connected, self-describing Web APIs with a minimum of fuss.
+Django REST framework aims to make it easy to build well-connected, self-describing Web APIs.
 
 Features:
 
 * Pluggable :mod:`.emitters`, :mod:`parsers`, :mod:`validators` and :mod:`authenticators` - Easy to customise.
 * Content type negotiation using HTTP Accept headers.
 * Optional support for forms as input validation.
-* Modular architecture - The MixIn classes can even be used without using the core :class:`.Resource` or :class:`.ModelResource` classes.
+* Modular architecture - MixIn classes can be used without requiring the :class:`.Resource` or :class:`.ModelResource` classes.
 
 For more information please head on over to the `discussion group <http://groups.google.com/group/django-rest-framework>`_.
 
 Getting Started
 ---------------
 
-Using Django REST framework can be as simple as adding a few lines to your urlconf::
+Using Django REST framework can be as simple as adding a few lines to your urlconf and adding a `permalink <http://docs.djangoproject.com/en/dev/ref/models/instances/#get-absolute-url>`_ to your model.
+
+`urls.py`::
 
     from django.conf.urls.defaults import patterns, url
     from djangorestframework import ModelResource, RootModelResource
 
     urlpatterns = patterns('',
         url(r'^$', RootModelResource.as_view(model=MyModel)),
-        url(r'^(?P<pk>[^/]+)/$', ModelResource.as_view(model=MyModel)),
+        url(r'^(?P<pk>[^/]+)/$', ModelResource.as_view(model=MyModel), name='my-model'),
      )
 
+`models.py`::
+
+    class MyModel(models.Model):
+
+        # (Rest of model definition...)
+
+        @models.permalink
+        def get_absolute_url(self):
+            return ('my-model', (self.pk,))
+
 Django REST framework comes with two "getting started" examples.
 
 #. :ref:`resources`