Skip to content

Commit ad61933

Browse files
committed
minor rewording/reformatting in README
1 parent d527ce4 commit ad61933

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ Run the `_build/default/src/monorobot.exe` binary. The following commands are su
2626

2727
## Getting Started
2828

29-
1. Upload a **repository configuration** file to the root of your target repository.
30-
1. Place a **secrets** file locally on the server.
31-
1. Configure GitHub
29+
1. Commit a **repository configuration** file to the root of your target repository.
30+
2. Place a **secrets** file locally on the server.
31+
3. Configure GitHub
3232
1. If targeting a private repository, set up a [personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) with `repo` scope and store it in the `gh_token` field of the secrets file.
33-
1. [Create a webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/creating-webhooks#setting-up-a-webhook) for the repository you are targeting. Set the *Payload URL* to be `<server_domain>/github`.
34-
1. You can optionally [secure the webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks) with a token, and store it in the `gh_hook_token` field of the secrets file.
35-
1. Configure Slack
33+
2. [Create a webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/creating-webhooks#setting-up-a-webhook) for the repository you are targeting. Set the *Payload URL* to be `<server_domain>/github`.
34+
3. You can optionally [secure the webhook](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks) with a token, and store it in the `gh_hook_token` field of the secrets file.
35+
4. Configure Slack
3636
1. [Create a Slack app](https://api.slack.com/apps?new_app=1). Click on "Basic Information" in the left sidebar, and update your secrets file with the `slack_client_id` and `slack_client_secret` with information from the page. You can optionally provide the `slack_signing_secret` to enforce [signature checking](https://api.slack.com/authentication/verifying-requests-from-slack) on incoming requests from Slack.
37-
1. Click on "OAuth & Permissions" in the sidebar. Give your bot a *Bot Token Scope* of `chat:write`.
38-
2. Click "Install to Workspace", and when prompted to grant permissions to your workspace, click "Allow".
39-
3. Copy the generated OAuth access token (`xoxb-XXXX`) to the `slack_access_token` field of your secrets file. This token is used by the bot to authenticate to the workspace, and remains valid until the token is revoked or the app is uninstalled.
37+
2. Click on "OAuth & Permissions" in the sidebar. Give your bot a *Bot Token Scope* of `chat:write`.
38+
3. Click "Install to Workspace", and when prompted to grant permissions to your workspace, click "Allow".
39+
4. Copy the generated OAuth access token (`xoxb-XXXX`) to the `slack_access_token` field of your secrets file. This token is used by the bot to authenticate to the workspace, and remains valid until the token is revoked or the app is uninstalled.
4040

4141
### OAuth Authorization
4242

0 commit comments

Comments
 (0)