Commit cc8f01f5 authored by Adrián Ribao's avatar Adrián Ribao
Browse files

Installation instructions in README

parent 93debc79
Pipeline #229 passed with stage
in 44 seconds
...@@ -12,12 +12,35 @@ Cartero is a newsletter app for Django with the following features: ...@@ -12,12 +12,35 @@ Cartero is a newsletter app for Django with the following features:
* Automatically convert HTML emails to text versions * Automatically convert HTML emails to text versions
* Dinamic variables in templates * Dinamic variables in templates
* It's possible to send test emails * It's possible to send test emails
* Rate Limit emails per second
# Installation
Installation is easy. It requires celery configured in order to send emails as an asynchronous task.
1. Add `cartero` to **INSTALLED_APPS**
2. Add cartero urls:
```python
url(r'^cartero/', include('cartero.urls')),
```
3. Add the celery task
```python
CELERYBEAT_SCHEDULE = {
'runs-every-minute': {
'task': 'cartero.tasks.check_campaigns',
'schedule': timedelta(seconds=60),
},
}
```
# TODO: # TODO:
* Rate Limit emails
* Create lists of users * Create lists of users
# Authors # Authors
* Adrián Ribao. [Twitter](http://twitter.com/AdrianRibao). * Adrián Ribao. [Twitter](http://twitter.com/AdrianRibao).
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment