summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6cf9dc6..a8798c9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,14 @@
Heroku Periodic
===============
-A skeleton app based on Heroku/Python/Flask/Celery that runs a single worker executing periodical tasks.
+A skeleton app based on Heroku/Python/Celery that runs a single worker executing periodical tasks.
+
+This skeleton can be used to quickly run periodical tasks on the Heroku platform using an arbitrary `timedelta` or `crontab` entry. The code is based on a single worker which runs with an integrated `celery beat` scheduler to avoid using a separate process just for scheduling. Redis is used as the broker, based on the `redistogo:nano` plan.
+
+Deployment
+----------
+
+ - `heroku create`
+ - `heroku addons:add redistogo:nano`
+ - `git push heroku master`
+ - `heroku ps:scale worker=1`