updated README

This commit is contained in:
Joel McCoy
2015-03-08 18:21:54 -07:00
parent 58b1ad1d89
commit 2ed3ac268d

View File

@@ -6,17 +6,24 @@ A turn-key, beginner-friendly, ready-to-deploy implementation of a traditional \
Create your [Twitter app](https://apps.twitter.com) and generate access tokens with *Read, Write and Direct Messages* privileges. Create your [Twitter app](https://apps.twitter.com) and generate access tokens with *Read, Write and Direct Messages* privileges.
### Deploy using Papertrail online log addon
#### [Valid Credit Card required, but free to use]
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/deploy-no-card)
### Deploy with no Papertrail addon [no card required] ### Deploy with no Papertrail addon [no card required]
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/deploy) [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/deploy)
### Deploy using Papertrail for online logs
#### [Valid Credit Card required, but free to use]
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/deploy-no-card)
### Deploy using Papertrail and Cloudinary for persistent files
#### [Valid Credit Card required, but free to use]
[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy?template=https://github.com/BooDoo/ebooks_example/tree/persist-cloudinary)
Put your BOT_NAME, SOURCE_USERNAME, and API secrets into Heroku Config Vars using the web dashboard. Put your BOT_NAME, SOURCE_USERNAME, and API secrets into Heroku Config Vars using the web dashboard.
*IF USING CLOUDINARY:* Optionally set the filename of starting corpus (`tweets.csv`, an ebooks json archive, or a plaintext file) and upload via Cloudinary dashboard.
Scale your app to 1 dyno using the Heroku web dashboard. Scale your app to 1 dyno using the Heroku web dashboard.
Bob's your uncle. Bob's your uncle.
@@ -35,7 +42,7 @@ Favorites tweets that it likes.
- Want something else? Create an [issue](https://github.com/BooDoo/ebooks_example/issues). No promises. - Want something else? Create an [issue](https://github.com/BooDoo/ebooks_example/issues). No promises.
## TODO: ## TODO:
- Support full archive (via CSV uploaded elsewhere) - This is a mess and needs a total rewrite with actual design
# DISCLAIMER: # 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. 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.