From: Charles Connell <charles@connells.org>
Date: Tue, 27 May 2014 17:00:11 +0000 (-0400)
Subject: Document celery change
X-Git-Tag: release-20150131~29
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=826bedc0bff0566c30558c9ba6423663701457ec;p=oweals%2Fkarmaworld.git

Document celery change
---

diff --git a/README.md b/README.md
index f44917b..01b994f 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,14 @@ documentation will operate assuming Heroku is in use.
 
 See README.heroku for more information.
 
+### Celery Queue
+Celery uses the Apache Message Queueing Protocol for passing messages to its workers.
+We recommend using Heroku's CloudAMQP add-on, getting your own CloudAMQP account, or
+running a queueing system on your own. The `CLOUDAMQP_URL` environment variable must be set correctly
+for KarmaNotes to be able to use Celery. The `CELERY_QUEUE_NAME` environment variable
+must be set to the name of the queue you wish to use. Settings this to something unique
+allows multiple instances of KarmaNotes (or some other software) to share the same queueing server.
+
 ### Amazon S3
 The instructions for creating an [S3](http://aws.amazon.com/s3/) bucket may be
 [found on Amazon.](http://docs.aws.amazon.com/AmazonS3/latest/gsg/CreatingABucket.html)