Skip to content

Commit 4d29411

Browse files
committed
docs: add testing section to README
1 parent 494dbb7 commit 4d29411

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,21 @@ A friendly slack bot for announcing upcoming Hashrocket observed holidays and
66
time off - communicating those in a timely manner makes us better consultants !
77

88
Based on the Hashrocket Employee Handbook.
9+
10+
## Testing
11+
12+
The best way to verify the integration is to run the app locally, talking to
13+
Slack.
14+
15+
You can change the channel in the `Announcer` in `lib/offbot/announcer.rb`, but
16+
keep in mind the channel must have the app installed to send messages.
17+
`#chicago` channel is a good test channel with fewer members to get spammed
18+
than `#general`.
19+
20+
You'll need the api token from Heroku, it can be looked up via `heroku config`.
21+
22+
To run the announcer locally:
23+
24+
``` bash
25+
% SLACK_API_TOKEN=xxx bundle exec rake announce
26+
```

0 commit comments

Comments
 (0)