README.rdoc in pusher-client-0.6.0 vs README.rdoc in pusher-client-0.6.1
- old
+ new
@@ -1,8 +1,8 @@
= pusher-client (Ruby)
-{<img src="https://travis-ci.org/pusher/pusher-ruby-client.png" />}[https://travis-ci.org/pusher/pusher-ruby-client]
+{<img src="https://travis-ci.org/pusher/pusher-websocket-ruby.png" />}[https://travis-ci.org/pusher/pusher-websocket-ruby]
pusher-client is a ruby gem for consuming WebSockets from the Pusher[http://pusherapp.com] web service.
The connection to Pusher can optionally be maintained in its own thread (see Asynchronous Usage).
@@ -11,16 +11,16 @@
When binding to a global event, note that you still must be subscribed to the channels the event
may be sent on. You can't just bind a global event without subscribing to any channels and call it a day.
== Installation
gem install pusher-client
-
+
== Single-Threaded Usage
The application will pause at socket.connect and handle events from Pusher as they happen.
require 'pusher-client'
- options = {:secret => 'YOUR_APPLICATION_SECRET'}
+ options = { secure: true }
socket = PusherClient::Socket.new(YOUR_APPLICATION_KEY, options)
# Subscribe to two channels
socket.subscribe('channel1')
socket.subscribe('channel2')
@@ -82,10 +82,10 @@
However it can optionally use a native C or Java implementation for a 25% speed
increase by including the websocket-native[https://github.com/imanel/websocket-ruby-native]
gem in your Gemfile.
== Contributing to pusher-client
-
+
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution