diff --git a/README.md b/README.md index 6444507..691227b 100644 --- a/README.md +++ b/README.md @@ -53,9 +53,16 @@ gem 'lita-tox', '~> 0.2.0' ### Configuration +`config.robot.name` will be used as Tox user name + +Mentions in Tox usually use user name, Tox clients usually allow mentioning +by writing first letters of user name and pressing ``, so don't use +`config.robot.mention_name` + #### Optional attributes - `savedata_filename` (String) - Path to file where Tox state will be stored (if provided) +- `status` (String) - Tox user status #### Example @@ -63,11 +70,11 @@ This is an example `lita_config.rb` file: ```ruby Lita.configure do |config| - config.robot.name = 'Lita' - config.robot.mention_name = 'lita' + config.robot.name = 'Lita chat bot' config.robot.adapter = :tox config.savedata_filename = 'savedata' + config.status = "Send me \"#{config.robot.name}: help\"" end ```