README.md in lita-2.3.0 vs README.md in lita-2.4.0
- old
+ new
@@ -1,8 +1,9 @@
# Lita
-[](https://travis-ci.org/jimmycuadra/lita)
+[](http://badge.fury.io/rb/lita)
+[](https://travis-ci.org/jimmycuadra/lita)
[](https://codeclimate.com/github/jimmycuadra/lita)
[](https://coveralls.io/r/jimmycuadra/lita)
@@ -19,10 +20,11 @@
* Built-in web server and routing
* Support for outgoing HTTP requests
* Group-based authorization
* Configurable logging
* Generators for creating new plugins
+* Built-in process daemonization
## Why?
Lita draws much inspiration from GitHub's fantastic [Hubot](http://hubot.github.com/), but has a few key differences and strengths:
@@ -208,11 +210,13 @@
```
Each method that is called by a route takes one argument, a `Lita::Response` object. This object has the following useful methods:
* `reply` - Sends one or more string messages back to the source of the original message, either a private message or a chat room.
+* `reply_privately` - Sends one or more string messages back to the user who sent the original message, whether it initated in a private message or a chat room.
* `matches` - An array of regular expression matches obtained by calling `body_of_message.scan(route_regex)`.
+* `match_data` - A `MatchData` object obtained by calling `route_regex.match(body_of_message)`.
* `args` - The user's message as an array of strings, as it would be parsed by `Shellwords.split`. For example, if the message was "Lita: auth add joe committers", calling `args` would return `["add", "joe", "committers"]`. ("auth" is considered the command and so is not included in the arguments.) This is very handy for commands that take arguments in a way similar to how a UNIX shell would work.
* `message` - A `Lita::Message` object for the incoming message.
* `user` - A `Lita::User` object for the user who sent the message.
Additionally, handlers have access to these top-level methods:
@@ -414,12 +418,28 @@
## API documentation
Complete documentation for all of Lita's classes and methods can be found at [rdoc.info](http://rdoc.info/gems/lita/frames).
-## Try it out
+## Available plugins
-You can chat with an instance of Lita on the Freenode IRC network in the channel `#litabot`. The bot's name is also *Litabot*.
+* [Adapters](https://github.com/jimmycuadra/lita/wiki/Adapters)
+* [Handlers](https://github.com/jimmycuadra/lita/wiki/Handlers)
+
+If you release a Lita plugin of your own, be sure to add it to one of the above lists!
+
+## Questions, feedback, and discussion
+
+* [Google Group](http://groups.google.com/group/litaio)
+* [IRC](https://webchat.freenode.net/) (`#lita.io` on the Freenode network)
+
+## Bug reports
+
+* [GitHub Issues](https://github.com/jimmycuadra/lita/issues)
+
+## Contributing
+
+See the [contribution guide](https://github.com/jimmycuadra/lita/blob/master/CONTRIBUTING.md).
## History
For a history of releases, see the [Releases](https://github.com/jimmycuadra/lita/releases) page.