README.md in twitter_ebooks-2.1.5 vs README.md in twitter_ebooks-2.1.6

- old
+ new

@@ -1,6 +1,6 @@ -# twitter\_ebooks 2.1.5 +# twitter\_ebooks 2.1.6 Rewrite of my twitter\_ebooks code. While the original was solely a tweeting Markov generator, this framework helps you build any kind of interactive twitterbot which responds to mentions/DMs. ## Installation @@ -52,16 +52,18 @@ end ``` Bots defined like this can be spawned by executing `run.rb` in the same directory, and will operate together in a single eventmachine loop. The easiest way to run bots in a semi-permanent fashion is with [Heroku](https://www.heroku.com); just make an app, push the bot repository to it, enable a worker process in the web interface and it ought to chug along merrily forever. +The underlying [tweetstream](https://github.com/tweetstream/tweetstream) and [twitter gem](https://github.com/sferik/twitter) client objects can be accessed at `bot.stream` and `bot.twitter` respectively. + ## Archiving accounts twitter\_ebooks comes with a syncing tool to download and then incrementally update a local json archive of a user's tweets. ``` zsh -➜ ebooks-ebooks git:(master) ebooks archive 0xabad1dea corpus/0xabad1dea.json +➜ ebooks archive 0xabad1dea corpus/0xabad1dea.json Currently 20209 tweets for 0xabad1dea Received 67 new tweets ``` The first time you'll run this, it'll ask for auth details to connect with. Due to API limitations, for users with high numbers of tweets it may not be possible to get their entire history in the initial download. However, so long as you run it frequently enough you can maintain a perfect copy indefinitely into the future. @@ -69,10 +71,10 @@ ## Text models In order to use the included text modeling, you'll first need to preprocess your archive into a more efficient form: ``` zsh -➜ ebooks-ebooks git:(master) ebooks consume corpus/0xabad1dea.json +➜ ebooks consume corpus/0xabad1dea.json Reading json corpus from corpus/0xabad1dea.json Removing commented lines and sorting mentions Segmenting text into sentences Tokenizing 7075 statements and 17947 mentions Ranking keywords