Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: cleaned up README #1

Merged
merged 1 commit into from
Mar 30, 2021
Merged

fix: cleaned up README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
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.