diff --git a/README.md b/README.md index b6b369c..9793011 100644 --- a/README.md +++ b/README.md @@ -64,14 +64,19 @@ config :slax, Slax.Slack, ```./bin/server``` All commands provide usage details when executing them without any parameters. +### /token +This is a slack shortcut that is an interactive series of modals to setup project repo connections in the database as well as store fine grained access tokens to enable issue lookup and poker functionality. **This is necessary** for proper functionality of Issue/PR lookup and Poker. + +The first modal you see lets you select a Repo and attach an access token and expiration date to it. +The second modal is accessed by clicking Create Repo and lets you either select or create a new Project and attach a Repo to the Project + +To generate a fine grained access token go to https://github.com/settings/tokens?type=beta and fill out the form. Check `Only Select Repositories` and select the desired repo(s). Under Repository Permissions, give at least Read and write to `Issues` and Read only to `Pull Requests` + ### Issue & PR lookup -With the websocket connection slax parses every message for the specified patterns corresponding to an issue `org/repo#1` `repo#1` or a PR `org/repo$1` `repo$1` +With the websocket connection slax parses every message for the specified patterns corresponding to an issue `org/repo#1` `repo#1` or a PR `org/repo$1` `repo$1`. ### /poker -This command is the interaction point for the poker feature and when just typing `/poker` it will respond with a help message on how to use it - -### /token -This is a slack shortcut that is an interactive series of modals to setup project repo connections in the database as well as store fine grained access tokens to enable issue lookup and poker functionality +This command is the interaction point for the poker feature and when just typing `/poker` it will respond with a help message on how to use it. ### _The following commands have not been tested or used in a while_