README.md in socky-client-0.4.3 vs README.md in socky-client-0.5.0.beta1
- old
+ new
@@ -1,23 +1,41 @@
-Socky - client in Ruby
-===========
+# Socky - client in Ruby [](http://travis-ci.org/socky/socky-client-ruby)
-Socky is push server for Ruby based on WebSockets. It allows you to break border between your application and client browser by letting the server initialize a connection and push data to the client.
+Also important information can be found on our [google group](http://groups.google.com/group/socky-users).
-## Getting Started
+## Installation
-- [Install](http://github.com/socky/socky-client-ruby/wiki/install) the gem
-- Read up about its [Usage](http://github.com/socky/socky-client-ruby/wiki/usage) and [Configuration](http://github.com/socky/socky-client-ruby/wiki/configuration)
-- Try [Example Application](http://github.com/socky/socky-example) or [demo page](http://sockydemo.imanel.org)
-- Fork and Contribute your own modifications
-- See [sites using socky](http://github.com/socky/socky-server-ruby/wiki/sites)
-- Discuss on [google group](http://groups.google.com/group/socky-framework)
+``` bash
+$ gem install socky-client --pre
+```
+## Usage
+
+First require Socky Client:
+
+``` ruby
+require 'socky/client'
+```
+
+Then createn new Client instance. Parameters required are full address of Socky Server(including app name) and secret of app.
+
+``` ruby
+$socky_client = Socky::Client.new('http://ws.socky.org:3000/http/test_app', 'my_secret')
+```
+
+This instance of Socky Client can trigger events for all users of server. To do so you can use one of methods:
+
+``` ruby
+$socky_client.trigger!('my_event', :channel => 'my_channel', :data => 'my data') # Will raise on error
+$socky_client.trigger('my_event', :channel => 'my_channel', :data => 'my data') # Will return false on error
+$socky_client.trigger_async('my_event', :channel => 'my_channel', :data => 'my data') # Async method
+```
+
## License
(The MIT License)
-Copyright (c) 2010 Bernard Potocki
+Copyright (c) 2010 Bernard Potocki
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
\ No newline at end of file