From: Charles Connell <charles@connells.org>
Date: Fri, 3 Jan 2014 19:39:06 +0000 (-0500)
Subject: Document twitter secrets better
X-Git-Tag: release-20150131~318
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=a73a9ce82526c59c16e35d1e84bf11f83a01d854;p=oweals%2Fkarmaworld.git

Document twitter secrets better
---

diff --git a/README.md b/README.md
index 23227b4..8ef77dc 100644
--- a/README.md
+++ b/README.md
@@ -118,6 +118,19 @@ access token key and secret are needed by the software.
 
 If the required files are not found, then no errors will occur.
 
+To set this up, create a new Twitter application at https://dev.twitter.com/apps/new.
+Make sure this application has read/write access. Generate an access token. Go to your
+OAuth settings, and grab the "Consumer key", "Consumer secret", "Access token", and
+"Access token secret".
+
+Create a file at karmaworld/secret/twitter.py, and enter these tokens. For example,
+```
+CONSUMER_KEY = '???'
+CONSUMER_SECRET = '???'
+ACCESS_TOKEN_KEY = '???'
+ACCESS_TOKEN_SECRET = '???'
+```
+
 # Development Install
 
 If you need to setup the project for development, it is highly recommend that