Skip to content

Commit

Permalink
Updated readme and config example to be a bit more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
shaunburdick committed Nov 29, 2016
1 parent 6c263e8 commit 3b69e31
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -69,7 +69,7 @@ The bot can announce which users are out of office on a schedule. To enable this
## Install
1. Clone this [repository](https://github.com/shaunburdick/slack-ooo.git)
2. `npm install`
3. Copy `config.default.js` to `config.js` and fill it out
3. Copy `./config.default.js` to `./config.js` (the same root directory) and fill it out
4. `npm start`

## Test
Expand Down
14 changes: 11 additions & 3 deletions config.default.js
@@ -1,13 +1,21 @@
var config = {
// App related configuration
app: {
// Setup channels and times you would like the bot to announce OoO users
// Example: To announce every 8am in the #general channel
// announce: {
// channels: [ 'general' ],
// times: [ '8:00' ]
// }
announce: {
channels: [], // no need to include #
times: [] // 24 hours
times: [] // 24 hours, so 1:00 pm is 13:00
}
},
// Slack related configuraton
slack: {
token: 'xoxb-foo',
autoReconnect: true
token: 'xoxb-foo', // The token for your slack bot
autoReconnect: true // if you want the bot to attempt reconnection
}
};
module.exports = config;

0 comments on commit 3b69e31

Please sign in to comment.