From f7f838390b825bcb4cc70a82eea224d0592a70e6 Mon Sep 17 00:00:00 2001 From: Oliver Sauder Date: Tue, 24 Jul 2018 08:54:15 +0200 Subject: [PATCH] Document goals of Django REST Framework See also https://github.com/django-json-api/django-rest-framework-json-api/issues/155#issuecomment-301172555 --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index f4cfdf21..9ab99836 100644 --- a/README.rst +++ b/README.rst @@ -62,6 +62,20 @@ like the following:: } +----- +Goals +----- + +As a Django REST Framework JSON API (short DJA) we are trying to address following goals: + +1. Support the [JSON API](http://jsonapi.org/) spec to compliance +2. Be as compatible with Django REST Framework as possible + e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA +3. Have sane defaults to be as easy to pick up as possible +4. Be solid and tested with good coverage +5. Be performant + + ------------ Requirements ------------