Updated example documentation
[twitter4r.git] / examples / configure.rb
bloba1f1d04e6fea3f6864ea8602aaebd66d7b3d0e1e
1 # = Configuration API Examples
2 #  require('rubygems')
3 #  gem('twitter4r', '0.2.0')
4 #  require('twitter')
5
6 # Here we setup configuration for all Twitter::Client instances
7 # This looks much like Rails' Initializer code that can be found 
8 # in config/environment in Rails applications by design.
9 #  Twitter::Client.configure do |conf|
10 #    # We can set Twitter4R to use <tt>:ssl</tt> or <tt>:http</tt> to connect to the Twitter API.
11 #    # Defaults to <tt>:ssl</tt>
12 #    conf.protocol = :ssl
14 #    # We can set Twitter4R to use another host name (perhaps for internal
15 #    # testing purposes).
16 #    # Defaults to 'twitter.com'
17 #    conf.host = 'twitter.com'
19 #    # We can set Twitter4R to use another port (also for internal 
20 #    # testing purposes).
21 #    # Defaults to 443
22 #    conf.port = 443
23 #    
24 #    # We can set proxy information for Twitter4R
25 #    # By default all following values are set to <tt>nil<tt>.
26 #    conf.proxy_host = 'myproxy.host'
27 #    conf.proxy_port = 8080
28 #    conf.proxy_user = 'myuser'
29 #    conf.proxy_pass = 'mypass'
30 #  end