Skip to content

Commit

Permalink
docs(slack): add required bot scopes to readme (#40)
Browse files Browse the repository at this point in the history
* Update README.md

Fix package path.
Add information about Slack scopes.

* fix linter issue

---------

Co-authored-by: Zach Hammer <zhammer@seatgeek.com>
  • Loading branch information
gchenuet and zhammer committed Mar 3, 2024
1 parent 812bd52 commit 086782d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion plugins/slack-catalog-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Install the `@seatgeek/backstage-plugin-slack-catalog-backend` package in your b

```shell
# From your Backstage root directory
yarn add --cwd packages/app @seatgeek/backstage-plugin-slack-catalog-backend
yarn add --cwd packages/backend @seatgeek/backstage-plugin-slack-catalog-backend
```

Add the following config to your `app-config.yaml`:
Expand All @@ -20,6 +20,8 @@ slackCatalog:
token: ${SLACK_API_TOKEN_CATALOG}
```

More information about Slack scopes [requirements](https://api.slack.com/scopes/users:read.email).

## Processors

### `SlackUserProcessor`
Expand Down

0 comments on commit 086782d

Please sign in to comment.