Updated example documentation
[twitter4r-core.git] / examples / friendship.rb
blob0637068334b4e9b620ef629a5c8e993265975534
1 # = Friendship API Examples
2 #  require('rubygems')
3 #  gem('twitter4r', '0.2.0')
4 #  require('twitter')
5
6 # The following is only required if you want to use some configuration 
7 # helper methods like <tt>Twitte4R::Client.from_config</tt> for 
8 # sensitive/instance context.
9 #  require 'twitter/console'
10 #  
11 #  config_file = File.join(File.dirname(__FILE__), '..', 'config', 'twitter.yml')
12 #  
13 # Not configuring Twitter::Client for global features such as overriding:
14 # * protocol
15 # * host
16 # * port
17 # * user agent
18 # * proxy information
19 # Since the defaults are satisfactory, but if you need to, please refer to 
20 # the {<tt>configure.rb</tt>}[file:configure_rb.html] example code.
21 #  twitter = Twitter::Client.from_config(config_file)
22
23