Skip to content
This repository has been archived by the owner on Aug 20, 2023. It is now read-only.

Commit

Permalink
added rst readme for django mailjet
Browse files Browse the repository at this point in the history
  • Loading branch information
wolph committed Sep 12, 2013
1 parent c8d7100 commit 26a8016
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions mailjet/contrib/django_mailjet/README.rst
@@ -0,0 +1,32 @@
Django integration
------------------

Introduction
============

``mailjet.contrib.django_mailjet`` provides generic tools to plug basic
mailjet support in your project.

Advanced users may use
``mailjet.contrib.django_mailjet.forms.SubscriptionForm`` directly
without installing anything.

Installation
============

In ``settings.py``:

- set ``MAILJET_LIST_NAME`` and ``MAILJET_LIST_LABEL``, note that it
may not contain non-alphanumeric characters, those are used as
defaults for
``mailjet.contrib.django_mailjet.forms.SubscriptionForm``,
- add to ``INSTALLED_APPS``: ``mailjet.contrib.django_mailjet`` for
templates to be loadable.

Include ``mailjet.contrib.django_mailjet.urls`` in ``urls.py``, ie.:

.. code:: py
url(r'^newsletter/', include('mailjet.contrib.django_mailjet.urls')),
Users may now subscribe to your mailing list on ``/newsletter/``.

0 comments on commit 26a8016

Please sign in to comment.