diff --git a/README.rst b/README.rst index 2194897..f3e3ed3 100644 --- a/README.rst +++ b/README.rst @@ -48,6 +48,48 @@ Requirements .. _django-rest-framework: https://github.com/tomchristie/django-rest-framework .. _Sphinx: http://sphinx-doc.org/ + + +Installation +============ +Use pip to install from PyPI: + +.. code-block:: python + + pip install django-admin2 + +Add djadmin2 and rest_framework to your settings file: + +.. code-block:: python + + INSTALLED_APPS = ( + ... + 'djadmin2', + 'rest_framework', # for the browsable API templates + ... + ) + +Add djadmin2 urls to your URLconf: + +.. code-block:: python + + # urls.py + from django.conf.urls import patterns, include + + import djadmin2 + + djadmin2.default.autodiscover() + + + urlpatterns = patterns( + ... + url(r'^admin2/', include(djadmin2.default.urls)), + ) + + + + + How to write django-admin2 modules =====================================