README.md in lita-1.0.0 vs README.md in lita-1.1.0
- old
+ new
@@ -58,10 +58,11 @@
To configure Lita, edit the file `lita_config.rb` generated by the `lita new` command. This is just a plain Ruby file that will be evaluated when the bot is starting up. A Lita config file looks something like this:
``` ruby
Lita.configure do |config|
config.robot.name = "Sir Bottington"
+ config.robot.mention_name = "bottington"
config.robot.adapter = :example_chat_service
config.adapter.username = "bottington"
config.adapter.password = "secret"
config.redis.host = "redis.example.com"
config.handlers.karma.cooldown = 300
@@ -70,10 +71,11 @@
```
The main config objects are:
* `robot` - General settings for Lita.
- * `name` - The name the bot will use on the chat service.
+ * `name` - The display name the bot will use on the chat service.
+ * `mention_name` - The name the bot will look for in messages to determine if the message is being addressed to it. Usually this is the same as the display name, but in some cases it may not be. For example, on HipChat, display names are required to be a first and last name, such as "Lita Bot", whereas the mention system would use a name like "LitaBot". This value defaults to whatever the name is if it's not set.
* `adapter` - A symbol or string indicating the adapter to load.
* `log_level` - A symbol or string indicating the severity level of log messages to output. Valid options are, in order of severity - `:debug`, `:info`, `:warn`, `:error`, and `:fatal`. For whichever level you choose, log messages of that severity and greater will be output. The default level is `:info`.
* `admins` - An array of string user IDs which tell Lita which users are considered administrators. Only these users will have access to Lita's `auth` command.
* `redis` - Options for the Redis connection. See the [Redis gem](https://github.com/redis/redis-rb) documentation.
* `adapter` - Options for the chosen adapter. See the adapter's documentation.