Added documentation

Added documentation in README for socketcluster-client-ruby

Author: maanavshah

README.md

@@ -1,2 +1,243 @@
 # socketcluster-client-ruby
-Ruby client for socketcluster
+A Ruby client for socketcluster.io
+
+Refer below examples for more details.
+
+Overview
+--------
+This client provides following functionality
+
+- Easy to setup and use
+- Support for emitting and listening to remote events
+- Automatic reconnection
+- Pub/sub
+- Authentication (JWT)
+- Can be used for extensive unit-testing of all server side functions
+- Support for ruby >= 2.2.0
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'socketclusterclient'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install socketclusterclient
+
+Usage
+-----------
+Create instance of `Socket` class by passing url of socketcluster-server end-point
+
+```ruby
+    # Create a socket instance
+    socket = ScClient.new('ws://localhost:8000/socketcluster/')
+```
+**Important Note** : Default url to socketcluster end-point is always *ws://somedomainname.com/socketcluster/*.
+
+#### Registering basic listeners
+
+- Different functions are given as an argument to register listeners
+
+```ruby
+    require 'socketclusterclient'
+    require 'logger'
+
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::WARN
+
+    on_connect = -> { logger.info('on connect got called') }
+
+    on_disconnect = -> { logger.info('on disconnect got called') }
+
+    on_connect_error = -> { logger.info('on connect error got called') }
+
+    on_set_authentication = lambda do |socket, token|
+      logger.info("Token received #{token}")
+      socket.set_auth_token(token)
+    end
+
+    on_authentication = lambda do |socket, is_authenticated|
+      logger.info("Authenticated is #{is_authenticated}")
+    end
+
+    socket = ScClient.new('ws://localhost:8000/socketcluster/')
+    socket.set_basic_listener(on_connect, on_disconnect, on_connect_error)
+    socket.set_authentication_listener(on_set_authentication, on_authentication)
+    socket.connect
+```
+
+#### Connecting to server
+
+- For connecting to server
+
+```ruby
+    # This will send websocket handshake request to socketcluster-server
+    socket.connect
+```
+
+- By default reconnection to server is enabled, so to configure delay for connection
+
+```ruby
+    # This will set automatic-reconnection to socketcluster-server with delay of 2 seconds and repeat it infinitely
+    socket.set_delay(2)
+    socket.connect
+```
+
+- For disabling reconnection to server
+
+```ruby
+    # This will disable reconnection to socketcluster-server
+    socket.set_reconnection(false)
+```
+
+Emitting and listening to events
+--------------------------------
+
+#### Event emitter
+
+- To emit a specified event on the corresponding socketcluster-server. The object sent can be String, Boolean, Long or JSONObject.
+
+```ruby
+    # Emit an event
+    socket.emit(event_name, message);
+
+    socket.emit("chat", "Hi")
+```
+
+- To emit a specified event with acknowledgement on the corresponding socketcluster-server. The object sent can be String, Boolean, Long or JSONObject.
+
+```ruby
+    # Emit an event with acknowledgment
+    socket.emitack(event_name, message, ack_emit)
+
+    socket.emitack('chat', 'Hello', ack_emit)
+
+    ack_emit = lambda do |key, error, object|
+      puts "Got ack data => #{object} and error => #{error} and key => #{key}"
+    end
+```
+
+#### Event Listener
+
+- To listen an event from the corresponding socketcluster-server. The object received can be String, Boolean, Long or JSONObject.
+
+```ruby
+    # Receive an event
+    socket.on(event, message)
+
+    socket.on('ping', message)
+
+    message = lambda do |key, object|
+      puts "Got data => #{object} from key => #{key}"
+    end
+```
+
+- To listen an event from the corresponding socketcluster-server and send the acknowledgment back. The object received can be String, Boolean, Long or JSONObject.
+
+```ruby
+    # Receive an event and send the acknowledgement back
+    socket.onack(event, message_with_acknowledgment)
+
+    socket.onack('ping', ack_message)
+
+    ack_message = lambda do |key, object, block_ack_message|
+      puts "Got ack data => #{object} from key => #{key}"
+      block_ack_message.call('error lorem', 'data ipsum')
+    end
+```
+
+Implementing Pub-Sub via channels
+---------------------------------
+
+#### Creating a channel
+
+- For creating and subscribing to channels
+
+```ruby
+    # Subscribe to channel
+    socket.subscribe('yell')
+
+    # Subscribe to channel with acknowledgement
+    socket.subscribeack('yell', ack_subscribe)
+
+    ack_subscribe = lambda do |channel, error, _object|
+      puts "Subscribed successfully to channel => #{channel}" if error == ''
+    end
+```
+
+- For getting list of created channels
+
+```ruby
+    # Get all subscribed channel
+    channels = socket.get_subscribed_channels
+```
+
+#### Publishing an event on channel
+
+- For publishing an event
+
+```ruby
+    # Publish to a channel
+    socket.publish('yell', 'Hi')
+
+    # Publish to a channel with acknowledgment
+    socket.publishack('yell', 'Hi', ack_publish)
+
+    ack_publish = lambda do |channel, error, _object|
+      puts "Publish sent successfully to channel => #{channel}" if error == ''
+    end
+```
+
+#### Listening to channel
+
+- For listening to a channel event
+
+```ruby
+    # Listen to a channel
+    socket.onchannel('yell', channel_message)
+
+    channel_message = lambda do |key, object|
+      puts "Got data => #{object} from key => #{key}"
+    end
+```
+
+#### Un-subscribing to channel
+
+- For unsubscribing to a channel
+
+```ruby
+    # Unsubscribe to a channel
+    socket.unsubscribe('yell')
+
+    # Unsubscribe to a channel with acknowledgement
+    socket.unsubscribeack('yell', ack_unsubscribe)
+
+    ack_unsubscribe = lambda do |channel, error, _object|
+      puts "Unsubscribed to channel => #{channel}" if error == ''
+    end
+```
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/opensocket/socketcluster-client-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+License
+-------
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).