From 292d64599640a73038e740e5d13548b7ffb7f585 Mon Sep 17 00:00:00 2001
From: Joel McCoy <joelmccoy@gmail.com>
Date: Fri, 2 Jan 2015 18:57:54 -0500
Subject: [PATCH] First pass at README

---
 README.md    | 40 ++++++++++++++++++++++++++++------------
 defaults.env |  2 +-
 2 files changed, 29 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 4216342..c716538 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,35 @@
-# ebooks_example
+# boodoo_ebooks
 
-As requested, this is the [twitter_ebooks](https://github.com/mispy/twitter_ebooks) app which I use to run most of my own bots. It tweets one guaranteed tweet every 24h, always responds to interactions, and has some small unprompted interaction probability based on keyword matching.
+A turn-key, beginner-friendly, ready-to-deploy implementation of a traditional \_ebooks bot using Mispy's [twitter_ebooks](https://github.com/mispy/twitter_ebooks) library.
 
 ## Usage
 
-```bash
-git clone https://github.com/mispy/ebooks_example.git
-cd ebooks_example
-bundle install
-ebooks archive username corpus/username.json
-ebooks consume corpus/username.json
-```
+Create your [Twitter app](https://apps.twitter.com) and generate access tokens with *Read, Write and Direct Messages* privileges.
 
-Populate bots.rb with your auth details, the bot username and model name, then:
+[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/deploy)
 
-`ebooks start`
+Put your BOT_NAME, SOURCE_USERNAME, and API secrets into Heroku Config Vars using the web dashboard.
 
-Also runs as a Heroku app! See the [twitter_ebooks](https://github.com/mispy/twitter_ebooks) README for more information.
+Scale your app to 1 dyno using the Heroku web dashboard.
+
+Bob's your uncle.
+
+## Default Behavior
+Tweets once on startup.  
+Has 80% chance of tweeting every 2 hours.  
+Responds to mentions/DMs  
+Favorites tweets that it likes.
+
+## Special Features
+- **BLACKLIST**: accounts to not interact with  
+- **BANNED_TERMS**: words or phrases to obscure/censor  
+- DM commands (tweet, follow, unfollow, block, mention...)  
+- Follower parity (periodically compares following/followers and follows/unfollows as needed)  
+- Want something else? Create an [issue](https://github.com/BooDoo/ebooks_example/issues). No promises.
+
+## TODO:
+- Support full archive (via CSV uploaded elsewhere)  
+
+# DISCLAIMER:
+I'm making this because I wrote a two-part tutorial for an older version of the twitter_ebooks gem and my mentions turned into a tech support hellscape for months.  
+Please [create issues](https://github.com/BooDoo/ebooks_example/issues) if you have trouble. 🙏 Please do not tweet at me. 🙏
diff --git a/defaults.env b/defaults.env
index c1a2728..9b80925 100644
--- a/defaults.env
+++ b/defaults.env
@@ -4,7 +4,7 @@ CONSUMER_KEY=
 CONSUMER_SECRET=
 ACCESS_TOKEN=
 ACCESS_TOKEN_SECRET=
-TWEET_INTERVAL=2m
+TWEET_INTERVAL=2h
 TWEET_CHANCE=0.8
 BLACKLIST=tinysubversions, dril
 BANNED_TERMS=voldemort, evgeny morozov, heroku