Sha256: 82bf055e8f69ab4492f0bbe00131b446c00796a4dd387ae7a723e9f206430e0d

Contents?: true

Size: 944 Bytes

Versions: 3

Compression:

Stored size: 944 Bytes

Contents

# SimpleStream

A stripped-down Twitter streaming API client.

## Installation

Add this line to your application's Gemfile:

    gem 'simple_stream'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install simple_stream

## Usage

Simply provide your credentials:

```ruby
SimpleStream.configure do |config|
  config.consumer_key = 'YOUR_CONSUMER_KEY'
  config.consumer_secret = 'YOUR_CONSUMER_SECRET'
  config.access_token = 'YOUR_ACCESS_TOKEN'
  config.access_secret = 'YOUR_ACCESS_SECRET'
end
```

and start streaming:

```ruby
client = SimpleStream::Client.new
client.user do |message|
  # Do something with the JSON
end
```

## Contributing

1. Fork it ( http://github.com/jasonkriss/simple_stream/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
simple_stream-0.0.3 README.md
simple_stream-0.0.2 README.md
simple_stream-0.0.1 README.md