toxon
/
lita-tox
Archived
1
0
Fork 0

Edit README

This commit is contained in:
Braiden Vasco 2015-09-15 18:31:01 +00:00
parent 8180204dae
commit eff4232af2
1 changed files with 9 additions and 2 deletions

View File

@ -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 `<Tab>`, 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
```