Skip to content

Commit

Permalink
Merge pull request #1 from devrelcollective/README
Browse files Browse the repository at this point in the history
fix: cleaned up README
  • Loading branch information
davidgs authored Mar 30, 2021
2 parents 90cb25f + c87eaeb commit e5686c8
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

DictatorBot is used by the [DevRelCollective](https://devrelcollective.fun) to manage which moderator (Benevolent Dictator) is on-call at any given time.

It is build in GOLANG, using Camunda Platform BPM as an orchestration platform.
It is built in GOLANG, using Camunda Platform BPM as an orchestration platform.

It was written by [David G. Simmons](https://github.com/davidgs).

Expand All @@ -27,15 +27,17 @@ You will need an instance of [Camunda Platform BPM](https://camunda.com) running

Deploy the `DictatorBot.bpmn` file to your Camunda Platform instance.

Make sure that you have edited the proper server names in the `dictator.yaml` file to point to your servers.
Make sure that you have edited the proper server names in the `dictator.yaml` file to point to your servers.

## Using Dictator Bot

Available commands are:
1) help or ?
2) rotate or rotation to get the full rotation schedule
3) who to see who the current on-call person is
4) next to see who the next on-call person will be
5) @username to place someone on-call
6) auth or authorized to see who is authorized to use the DictatorBot
7) update to place the next person in the rotation on-call
1) `help` or `?`
2) `rotate` or `rotation` to get the full rotation schedule
3) `who` to see who the current on-call person is
4) `next` to see who the next on-call person will be
5) `@username` to place someone on-call
6) `auth` or `authorized` to see who is authorized to use the DictatorBot
7) `update` to place the next person in the rotation on-call

The DictatorBot can _only_ be called in channels where it has been invited, or in Direct Messages, and can _only_ be called by those listed in the `dictator.yaml` file.

0 comments on commit e5686c8

Please sign in to comment.