diff --git a/README.rst b/README.rst index ffb5f4f..87c9472 100644 --- a/README.rst +++ b/README.rst @@ -6,14 +6,28 @@ django-admin2 :alt: Build Status :target: https://travis-ci.org/pydanny/django-admin2 -**Warning:** This project is currently in an **alpha** state and currently not meant for production. +**Warning:** This project is currently in an **alpha** state and currently not meant for real projects. One of the most useful parts of ``django.contrib.admin`` is the ability to configure various views that touch and alter data. django-admin2 is a complete rewrite of that library using modern Class-Based Views and enjoying a design focused on extendibility. By starting over, we can avoid the legacy code and make it easier to write extensions and themes. -Contributing -============= +Features (current) +==================== -Yes please! Please read our formal contributing document at: https://github.com/pydanny/django-admin2/blob/master/docs/contributing.rst +* Easy-to-extend API that follows similar patterns to ``django.contrib.admin``. +* Built-in RESTFUL API powered by ``django-rest-framework``. +* Default theme built on Twitter Bootstrap. +* Easy to implement theme system. +* Basic permission controls. + +Features (Planned) +==================== + +* Much improved documentation including tutorials and reference guides. + + * Extending existing views + * Interacting with the basic Admin2 object. + +* More powerful permission controls Requirements ============= @@ -22,8 +36,14 @@ Requirements * Python 2.7+ (Python 3.3+ support is pending) * django-braces * django-rest-framework +* django-floppyforms * Sphinx (for documentation) +Contributing +============= + +Yes please! Please read our formal contributing document at: https://github.com/pydanny/django-admin2/blob/master/docs/contributing.rst + Basic Pattern ============== diff --git a/docs/index.rst b/docs/index.rst index 17149de..9e3f858 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,14 +7,6 @@ Welcome to django-admin2's documentation! This project is intentionally backwards-incompatible with ``django.contrib.admin``. -Features -========== - -* Easy-to-extend API that follows similar patterns to ``django.contrib.admin``. -* Built-in RESTFUL API powered by ``django-rest-framework`` -* Default theme built on Twitter Bootstrap -* Easy to implement theme system. - Requirements =============