README.md in tweetstream-2.4.0 vs README.md in tweetstream-2.5.0
- old
+ new
@@ -1,12 +1,21 @@
-# TweetStream [![Build Status](https://secure.travis-ci.org/intridea/tweetstream.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/intridea/tweetstream.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
-TweetStream provides simple Ruby access to [Twitter's Streaming API](https://dev.twitter.com/docs/streaming-api).
+# TweetStream
+[![Gem Version](https://badge.fury.io/rb/tweetstream.png)][gem]
+[![Build Status](https://secure.travis-ci.org/intridea/tweetstream.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/intridea/tweetstream.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/intridea/tweetstream.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/intridea/tweetstream/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/tweetstream
[travis]: http://travis-ci.org/intridea/tweetstream
[gemnasium]: https://gemnasium.com/intridea/tweetstream
[codeclimate]: https://codeclimate.com/github/intridea/tweetstream
+[coveralls]: https://coveralls.io/r/intridea/tweetstream
+TweetStream provides simple Ruby access to [Twitter's Streaming API](https://dev.twitter.com/docs/streaming-api).
+
## Installation
gem install tweetstream
## Usage
@@ -51,11 +60,12 @@
The methods available to TweetStream::Client are kept in parity
with the methods available on the Streaming API wiki page.
## Changes in 2.0
-TweetStream 2.0 introduces a number of requested features and bug fixes. For the complete list refer to the [changelog](https://github.com/intridea/tweetstream/blob/master/CHANGELOG.md#version-200). Notable
+TweetStream 2.0 introduces a number of requested features and bug fixes. For
+the complete list refer to the [changelog](CHANGELOG.md#version-200). Notable
additions in 2.0 include:
### OAuth
OAuth is now the default authentication method. Both userstreams and Site
@@ -326,10 +336,22 @@
```
If you put the above into a script and run the script with `ruby scriptname.rb`,
you will see a list of daemonization commands such as start, stop, and run.
+## Proxy Support
+
+TweetStream supports a configurable proxy:
+
+```ruby
+TweetStream.configure do |config|
+ config.proxy = { :uri => 'http://myproxy:8081' }
+end
+```
+
+Your proxy will now be used for all connections.
+
## REST
To access the Twitter REST API, we recommend the [Twitter][] gem.
[twitter]: https://github.com/sferik/twitter
@@ -341,6 +363,7 @@
* [Erik Michaels-Ober](https://github.com/sferik) (current maintainer)
* [Countless others](https://github.com/intridea/tweetstream/graphs/contributors)
## Copyright
-Copyright (c) 2012 Intridea, Inc. (http://www.intridea.com/). See [LICENSE](https://github.com/intridea/tweetstream/blob/master/LICENSE.md) for details.
+Copyright (c) 2012-2013 Intridea, Inc. (http://www.intridea.com/). See
+[LICENSE](LICENSE.md) for details.