Add readme, modify docs and some cleanup

README.md

-# {{ app_name }}
+# Cartero - Newsletter django app
 
 **Author:** Adrián Ribao. [Twitter](http://twitter.com/AdrianRibao).
 
-## Changelog
+Cartero is a newsletter app for Django with the following features:
 
-### v 0.1
+* Inline template editing
+* Dinamic content in templates defining placeholders
+* Track unsucriptions
+* Short URLs in template and monitor clicks
+* Track email views via a transparent image
+* Automatically convert HTML emails to text versions
+* Dinamic variables in templates
+* It's possible to send test emails
+
+TODO:
+
+* Rate Limit emails
+* Create lists of users

cartero/utils/sending.py

@@ -45,10 +45,6 @@ class CampaignDeliver(object):
                 head.remove(link)
 
         result = etree.tostring(tree.getroot(), pretty_print=True, method="html")
-        #print result
-        # CSS INLINER
-        #p = Premailer(result, remove_classes=False, include_star_selectors=True, strip_important=False)
-        #html = p.transform()
         html = inline_css(result)
         return html
 
@@ -78,8 +74,6 @@ class CampaignDeliver(object):
 
     def convert_email_to_text(self, html):
         h = html2text.HTML2Text()
-        #h.ignore_links = True
-        #h.inline_links = True
         text = h.handle(html.decode('utf-8'))
         return text
 

docs/source/index.rst

@@ -16,16 +16,16 @@ Installation
 
 .. code::
 
-    pip install {{ app_name }}
+    pip install cartero
 
-Add ``'{{ app_name }}'`` to ``INSTALLED_APPS``
+Add ``'cartero'`` to ``INSTALLED_APPS``
 
 Add the URLs to urls.py:
 
 .. code::
 
-    # Django users
-    url(r'^{{ app_name }}/', include('{{ app_name }}.urls')),
+    # Cartero URLs
+    url(r'^cartero/', include('cartero.urls')),
 
 Indices and tables
 ==================