Browse Source

Updated README markdown to break lines.

master
Bob 8 years ago
parent
commit
7d6c478e7c
  1. 22
      README.md

22
README.md

@ -35,9 +35,13 @@ Once you enter that information, you will be taken to the detailed settings for
In the OAuth section select the following permissions. In an effort to make you a bit more comfortable with granting these, each will be listed with a full description of what we use it for below: In the OAuth section select the following permissions. In an effort to make you a bit more comfortable with granting these, each will be listed with a full description of what we use it for below:
> admin - Used to access integration logs. > admin - Used to access integration logs.
> bot - Used to act as the bot user. > bot - Used to act as the bot user.
> chat:write:bot - Used to send messages as our bot. > chat:write:bot - Used to send messages as our bot.
> files:write:user - Used to upload messages as files if too large. > files:write:user - Used to upload messages as files if too large.
> users:read - Used to access the user list. > users:read - Used to access the user list.
Once you have granted those permissions, install the app and take note of the OAuth tokens that have been generated for you. Once you have granted those permissions, install the app and take note of the OAuth tokens that have been generated for you.
@ -53,31 +57,49 @@ The format of the config file is standard YAML formatting. If only one team is t
Within a team dictionary, the following keys are valid and may have the following values: Within a team dictionary, the following keys are valid and may have the following values:
> api\_token - A string token > api\_token - A string token
> bot\_token - A string token > bot\_token - A string token
> skip\_integrations - A boolean that skips the audit of active integrations > skip\_integrations - A boolean that skips the audit of active integrations
> integration\_whitelist - A dictionary (key=integration\_id) of lists of issues to ignore > integration\_whitelist - A dictionary (key=integration\_id) of lists of issues to ignore
> integration\_issue\_whitelist - A list of issues to ignore > integration\_issue\_whitelist - A list of issues to ignore
> user\_whitelist - A dictionary (key=id) of lists of issues to ignore > user\_whitelist - A dictionary (key=id) of lists of issues to ignore
> user\_issue\_whitelist - A list of issues to ignore > user\_issue\_whitelist - A list of issues to ignore
> output\_channel - The Slack channel name in which to output our results > output\_channel - The Slack channel name in which to output our results
Possible values for the issues with integrations are: Possible values for the issues with integrations are:
> legacy > legacy
> admin > admin
> chat:write:user > chat:write:user
> channels:history > channels:history
> files:read > files:read
> files:write:user > files:write:user
> groups:history > groups:history
> im:history > im:history
> mpim:history > mpim:history
> pins:read > pins:read
> search:read > search:read
Possible values for the issues with users are: Possible values for the issues with users are:
> 2fa > 2fa
> sms > sms
An example of how one might construct an actual working configuration from this is included in `example.yml`. An example of how one might construct an actual working configuration from this is included in `example.yml`.

Loading…
Cancel
Save