README.md in slack-rtmapi-1.0.0.rc1 vs README.md in slack-rtmapi-1.0.0.rc2
- old
+ new
@@ -3,5 +3,23 @@
All you need to use the RTM api of Slack
Please note that this gem is GPLv3. You *CAN'T* use it for proprietary software.
If you need a licence, please contact me and I will respond in the 24 hours.
+
+HOW TO USE
+----------
+
+```ruby
+require 'slack-rtmapi'
+
+url = SlackRTM.get_url token: 'xxx'
+client = SlackRTM::Client.new websocket_url: url
+
+client.on :message {|data| p data}
+
+client.main_loop
+assert false # never ending loop
+```
+
+For more informations about the Slack Real Time API, please check https://api.slack.com/rtm
+