Permalink
Browse files

Update the readme for userstream

  • Loading branch information...
1 parent ec944db commit ab19366eb14392c944e6db44d5a52fb736060b31 @coreyhaines coreyhaines committed Sep 24, 2011
Showing with 17 additions and 0 deletions.
  1. +17 −0 README.md
View
@@ -51,6 +51,23 @@ user ids:
The methods available to TweetStream::Client will be kept in parity
with the methods available on the Streaming API wiki page.
+Using the Twitter Userstream
+----------------------------
+
+Using the Twitter userstream works similarly to the regular usage, except you use the userstream method.
+
+ # Use 'userstream' to get message from your stream
+ TweetStream::Client.new.userstream do |status|
+ puts "#{status.text}"
+ end
+
+You also can listen to direct messages by supplying an on_direct_message proc
+
+ client = TweetStream::Client.new
+ client.on_direct_message do |direct_message|
+ puts "#{direct_message.text}"
+ end
+
Configuration and Changes in 1.1.0
----------------------------------

0 comments on commit ab19366

Please sign in to comment.