Permalink
Browse files

updated readme

  • Loading branch information...
1 parent d55fcf4 commit 3d2f838801806c992e1687a7a5cc23fd66c1629a @sherzberg sherzberg committed Aug 10, 2011
Showing with 16 additions and 14 deletions.
  1. +16 −14 README.txt
View
30 README.txt
@@ -7,35 +7,35 @@ and email lists. Emails can be created and bulk sent in a future date.
Required packages:
- Python Image Library (PIL)
+ - South
Optional Packages:
- django-tinymce
Features (that currently work):
- - (manually) Create and edit model/objects in models.py
- - (manually) Send queue emails
- - (manually) Send one off emails. Used in generic forms or for event notifications on your site
+ - Create EmailLists:
+ - Site users (list of auth.models.user objects)
+ - Raw email addresses (list of comma separated emails)
+ - Create EmailBlasts. Allows you to send email to EmailLists.
+ - Merge fields. Uses standard djangos template processor to fill in merge fields.
- Integrates with tinymce, just install django-tinymce and configure it appropriately
- - HTML and text content in emails
- - Tracking for opened emails (uses image requests for tracking so only possible for HTML clients)
- - South migrations
+ - HTML and text content in emails (uses html2text to generate the text content)
+ - Tracking for opened emails (currently uses html image requests for tracking so only possible for HTML clients)
Future Features:
- - Create email lists
- - Query
- - User defined
- - Email signup, like newsletters and such
- - Email merge fields based on the email lists or any supplied merge data
+ - EmailLists
+ - Custom sql query (query for email address and merge data)
- Celery async email jobs
- - Notification signals (register signals for custom events and get emails)
- Admin actions to process emails
- - Newsletter signups
- Doctor direct links to the site to include tracking information which will
provide tracking for people who paste links from text versions of the email
Setup:
- include in INSTALLED_APPS (settings.py)
...
+ 'django.contrib.sites',
+ 'south',
+ ...
'emailer',
...
@@ -44,7 +44,9 @@ Future Features:
- if using django-tinymce, put this in the tinymce.init config (enables tiny-mce templates to use emailer templates):
'template_external_list_url' : "emailer/templates/",
-
+
+ - update site instance in the admin to reflect your site, see the django docs for this
+
- sync up your models, see django-south for more information
$ python manage.py syncdb
$ python manage.py migrate emailer

0 comments on commit 3d2f838

Please sign in to comment.