Updated example documentation
[twitter4r-core.git] / README
blob6798088c1f103aec91e258a8c755f53bce24ce70
1 = Twitter4R
3 *Developers*: 
4 * Susan Potter (http://SusanPotter.NET)
5 *Contributors*: 
6 * Kaiichi Matsunaga <ma2 at lifemedia dot co dot jp>
8 Twitter4R provides an object based API to query or update your Twitter account via pure Ruby.  It hides the ugly HTTP/REST code from your code.
10 == External Dependencies
11 * Ruby 1.8 (tested with 1.8.4+)
12 * RSpec gem 1.0.0
13 * JSON gem 0.4.3
14 * jcode (for unicode support)
16 == Query Public Timeline
18   :include:examples/public_timeline.rb
19   
20 == Query Friend Timeline
22   :include:examples/friend_timeline.rb
24 == Query Friend Current Statuses
26   :include:examples/friend_statuses.rb
28 == Query Follower Current Statuses
30   :include:examples/follower_statuses.rb
32 == Update Your Status
34   :include:examples/update.rb
36 == Send Direct Message
37   :include:examples/direct_message.rb