README.md in wwl-websocket-rails-0.7.1 vs README.md in wwl-websocket-rails-0.7.2
- old
+ new
@@ -1,12 +1,29 @@
# Websocket-Rails
-[](https://travis-ci.org/websocket-rails/websocket-rails)
-[](http://badge.fury.io/rb/websocket-rails)
-[](https://codeclimate.com/github/websocket-rails/websocket-rails)
+[](https://travis-ci.org/wonderweblabs/websocket-rails)
+[](http://badge.fury.io/rb/wwl-websocket-rails)
+[](https://codeclimate.com/github/websocket-rails/websocket-rails)
+This gem is a fork from [websocket-rails](https://github.com/websocket-rails/websocket-rails).
+
+
+### Installation
+
+Require in your Gemfile:
+
+```bash
+gem 'wwl-websocket-rails', '~> 0.7.2'
+```
+
+
+---
+
+
+**Original content from websocket-rails with small changes**
+
If you haven't done so yet, check out the [Project
Page](http://websocket-rails.github.io) to get a feel for the project direction. Feedback is very much appreciated. Post an issue on the issue tracker or [shoot us an email](mailto:support@threedotloft.com) to give us your thoughts.
**Find us on IRC #websocket-rails**
@@ -51,17 +68,17 @@
Map events to controller actions using an Event Router.
````ruby
WebsocketRails::EventMap.describe do
namespace :tasks do
-
+
# using a Hash to specify the target
subscribe :create, :to => TaskController, :with_method => :create
-
+
# using the same syntax as routes.rb
subscribe :update, 'task#update'
-
+
# if your controller is not a top-level object
subscribe :create_admin, :to => Admin::TaskController, :with_method => :create
subscribe :update_admin, 'admin/task#update'
@@ -186,25 +203,25 @@
````
## Private Channel Support
Need to restrict access to a particular channel? No problem. We've got
-that.
+that.
Private channels give you the ability to authorize a user's
subscription using the authorization mechanism of your choice.
Just tell WebsocketRails which channels you would like to make private by using the `private_channel` method in the Event Router.
Then handle the channel authorization by subscribing to the `websocket_rails.subscribe_private` event.
````ruby
WebsocketRails::EventMap.describe do
private_channel :secret_posts
-
+
namespace :websocket_rails
subscribe :subscribe_private, :to => AuthorizationController, :with_method => :authorize_channels
end
-````
+````
Or you can always mark any channel as private later on.
````ruby
WebsocketRails[:secret_posts].make_private