Contents

# RedSocket [![Build Status](https://secure.travis-ci.org/m4risU/red_socket.png?branch=master)](http://travis-ci.org/m4risU/red_socket)

# RedSocket client

Send notification for clients listening on HTML5 websockets. See more details on http://red-socket.com .

## Installation

Add to your Gemfile and run the `bundle` command to install it.

```ruby
gem "red_socket"
```

Create `config/initializers/red_socket.rb` file wit following config:

```ruby
RedSocket::Base.configure do |config|
  config.account_id = "account_name" # within host name
  config.api_key = "some_api_key"
  config.api_secret = "some_secret_key"
end
```

Sign up for an account on http://red-socket.com/signup to get your key pair.


**Requires Ruby 1.9 or later.**

## Usage

Call `RedSocket.notify('my_channel')` to send message to listening clients. By default it will send a 'notification' event which can be passed as the second argument.

```ruby
RedSocket::Base.notify('my_channel', 'my_custom_event')
```

Additional message can be send within third parameter

```ruby
RedSocket::Base.notify('my_channel', 'my_custom_event', 'it can be for example a json message, so it can be parsed by the browser')
```

## Development

Questions or problems? Please post them on the [issue tracker](https://github.com/m4risu/red_socket/issues). You can contribute changes by forking the project and submitting a pull request. Feel free to do it.

This gem is created by Mariusz Wyrozebski and is under the MIT License.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
red_socket-0.0.2	README.md