README.rdoc in streambot-0.2.1 vs README.rdoc in streambot-0.2.2
- old
+ new
@@ -1,23 +1,26 @@
= streambot
-streambot is using (http://github.com/intridea/tweetstream) for simple access to twitter streaming api
-streambot is still far away from production usage
+streambot is using tweetstream (http://github.com/intridea/tweetstream) for simple access to twitter streaming api
== Installation
+the streambot gem is available on rubygems.org - http://rubygems.org/gems/streambot
+
gem install streambot
== Usage
require 'streambot'
- bot = StreamBot.new({:username=>'username',:password=>'password'},'apple','ipad','iphone os 4','steve jobs')
+ @auth = {:username=>'username',:password=>'password'}
+ @blacklist = ['mac_rt','apple_rt']
+ bot = StreamBot.new(@auth, @blacklist, 'apple','ipad','iphone os 4','steve jobs')
bot.start
== Todo
-* oauth authentication
+All todos are listed in issue-tracker and labeled with todo (http://github.com/gr4y/streambot/issues/labels/todo)
== Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.