README.markdown in twitter-stream-0.1.0 vs README.markdown in twitter-stream-0.1.1
- old
+ new
@@ -3,23 +3,35 @@
Simple Ruby client library for [twitter streaming API](http://apiwiki.twitter.com/Streaming-API-Documentation).
Uses [EventMachine](http://rubyeventmachine.com/) for connection handling. Adheres to twitter's [reconnection guidline](http://apiwiki.twitter.com/Streaming-API-Documentation#Connecting).
JSON format only.
+## Install
+
+ sudo gem install twitter-stream -s http://gemcutter.org
+
## Usage
+ require 'rubygems'
+ require 'twitter/json_stream'
+
EventMachine::run {
stream = Twitter::JSONStream.connect(
:path => '/1/statuses/filter.json?track=football',
- :auth => 'LOGIN:PASSWORD',
+ :auth => 'LOGIN:PASSWORD'
)
stream.each_item do |item|
- # do someting with unparsed JSON item
+ # Do someting with unparsed JSON item.
end
stream.on_error do |message|
- # log or something
+ # No need to worry here. It might be an issue with Twitter.
+ # Log message for future reference. JSONStream will try to reconnect after a timeout.
+ end
+
+ stream.on_max_reconnects do |timeout, retries|
+ # Something is wrong on your side. Send yourself an email.
end
}
## Examples