diff --git a/README.md b/README.md index 9c098c3..4a5c5c4 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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. \ No newline at end of file