README.rdoc in robut-0.4.0 vs README.rdoc in robut-0.5.0

- old
+ new

@@ -1,19 +1,9 @@ = Robut The friendly plugin-enabled HipChat bot. -== NOTE: Breaking backwards compatibility! - -A little while ago, HipChat changed the way their mention names -work. Instead of just using the first name ('@robut'), they now use -the full name ('@RobutTRobot'). Starting from v0.4.0, robut uses this -new format by default. If you prefer the old style, you can set it in -your Chatfile: - - config.mention_name = 'robut' - == Installation and usage Robut can be installed by running <tt>gem install robut</tt>. This installs the +robut+ binary. When run, +robut+ reads a Chatfile, connects to the specified HipChat server and chatroom, and feeds every @@ -46,9 +36,16 @@ first parameter: robut /path/to/Chatfile The Chatfile is just ruby code. A simple example can be found here: Chatfile[https://github.com/justinweiss/robut/blob/master/examples/Chatfile] + +== Robut::Web + +You can run Robut as a rack application, which allows it to accept +incoming post requests (e.g. Heroku deploy hooks, GitHub post-recieve hooks, etc.) +that can send messages to all connected rooms. Have a look at +config.ru[https://github.com/justinweiss/robut/blob/master/examples/config.ru] for an example. === Adding and configuring plugins Plugins are ruby classes, so enabling a plugin just requires requiring the plugin file, optionally configuring the plugin class, and adding