From e8fbc7f3428907b82aa7044c2faf8dd5fe79c784 Mon Sep 17 00:00:00 2001 From: Chris Jones Date: Tue, 28 Feb 2012 15:58:49 -0800 Subject: [PATCH] docs docs docs --- README.rst | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 959e28b..810e385 100644 --- a/README.rst +++ b/README.rst @@ -4,19 +4,18 @@ Djrill, for Mandrill Djrill is an email backend and new message class for Django users that want to take advantage of the Mandrill transactional email service from MailChimp. -Dependencies +Installation ------------ +:: + + pip install djrill + The only dependency other than Django is the ``requests`` library from Kenneth Reitz. If you do not install through PyPI you will need to do :: pip install requests -Installation ------------- - -``pip install djrill`` - Configuration ------------- @@ -38,6 +37,23 @@ In ``settings.py``: EMAIL_BACKEND = "djrill.mail.backends.djrill.DjrillBackend" +4. (optional) If you want to be able to add senders through Django's admin or view stats about your + messages, do the following in your base ``urls.py`` :: + + ... + from django.contrib import admin + + from djrill import DjrillAdminSite + + admin.site = DjrillAdminSite() + admin.autodiscover() + ... + + urlpatterns = patterns('', + ... + url(r'^admin/', include(admin.site.urls)), + ) + Usage -----