From c3babe751a6bab7c7888f173b7853a65ba2ea35e Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Fri, 1 Jul 2011 16:24:32 +0100 Subject: [PATCH] Tweak intro in README --- README.rst | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 244090d83..f5789ae08 100644 --- a/README.rst +++ b/README.rst @@ -3,11 +3,23 @@ Django REST framework Django REST framework makes it easy to build well-connected, self-describing RESTful Web APIs. +Features: + +* Creates awesome self-describing *web browse-able* APIs. +* Clean, modular design, using Django's class based views. +* Easily extended for custom content types, serialization formats and authentication policies. +* Stable, well tested code-base. +* Active developer community. + Full documentation for the project is available at http://django-rest-framework.org Issue tracking is on `GitHub `_. General questions should be taken to the `discussion group `_. +Requirements: + +* Python (2.5, 2.6, 2.7 supported) +* Django (1.2, 1.3 supported) Installation Notes @@ -76,7 +88,7 @@ Release Notes 0.2.3 * Fix some throttling bugs. -* X-Throttle header on throttling. +* ``X-Throttle`` header on throttling. * Support for nesting resources on related models. 0.2.2 @@ -92,24 +104,24 @@ Release Notes * Big refactoring changes since 0.1.0, ask on the discussion group if anything isn't clear. The public API has been massively cleaned up. Expect it to be fairly stable from here on in. -* `Resource` becomes decoupled into `View` and `Resource`, your views should now inherit from `View`, not `Resource`. +* ``Resource`` becomes decoupled into ``View`` and ``Resource``, your views should now inherit from ``View``, not ``Resource``. -* The handler functions on views .get() .put() .post() etc, no longer have the `content` and `auth` args. - Use `self.CONTENT` inside a view to access the deserialized, validated content. - Use `self.user` inside a view to access the authenticated user. +* The handler functions on views ``.get() .put() .post()`` etc, no longer have the ``content`` and ``auth`` args. + Use ``self.CONTENT`` inside a view to access the deserialized, validated content. + Use ``self.user`` inside a view to access the authenticated user. -* `allowed_methods` and `anon_allowed_methods` are now defunct. if a method is defined, it's available. - The `permissions` attribute on a `View` is now used to provide generic permissions checking. - Use permission classes such as `FullAnonAccess`, `IsAuthenticated` or `IsUserOrIsAnonReadOnly` to set the permissions. +* ``allowed_methods`` and ``anon_allowed_methods`` are now defunct. if a method is defined, it's available. + The ``permissions`` attribute on a ``View`` is now used to provide generic permissions checking. + Use permission classes such as ``FullAnonAccess``, ``IsAuthenticated`` or ``IsUserOrIsAnonReadOnly`` to set the permissions. -* The `authenticators` class becomes `authentication`. Class names change to Authentication. +* The ``authenticators`` class becomes ``authentication``. Class names change to ``Authentication``. -* The `emitters` class becomes `renderers`. Class names change to Renderers. +* The ``emitters`` class becomes ``renderers``. Class names change to ``Renderers``. -* `ResponseException` becomes `ErrorResponse`. +* ``ResponseException`` becomes ``ErrorResponse``. -* The mixin classes have been nicely refactored, the basic mixins are now `RequestMixin`, `ResponseMixin`, `AuthMixin`, and `ResourceMixin` - You can reuse these mixin classes individually without using the `View` class. +* The mixin classes have been nicely refactored, the basic mixins are now ``RequestMixin``, ``ResponseMixin``, ``AuthMixin``, and ``ResourceMixin`` + You can reuse these mixin classes individually without using the ``View`` class. 0.1.1