Skip to content

Commit

Permalink
chore: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ekremney committed Jan 26, 2024
1 parent 1902088 commit 77beb5d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
12 changes: 0 additions & 12 deletions packages/spacecat-shared-rum-api-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,6 @@ npm install @adobe/spacecat-shared-rum-api-client

## Usage

### Configuring Tokens

To configure tokens for your application, follow these steps:

1. Visit the main page of your Slack app at [https://api.slack.com/apps](https://api.slack.com/apps).

2. Navigate to the "OAuth & Permissions" page and locate the "Scope" section. Here, you can add scopes to your Slack app based on the specific methods you intend to use from the Slack API. For example, if your app requires file upload functionality, ensure you add the `files:read` and `files:write` scopes.

3. Locate your Slack bot token under the "Bot User OAuth Token" section on the same page. You will need to provide this token to the `SlackClient` in your application.

4. For information on the scopes needed for each Slack API method, refer to the [documentation](https://api.slack.com/methods). The required scopes for each API method are listed in the "Bot tokens" row. As an example, to use the `postMessage` API method, the required scope is `chat:write`, as documented in [https://api.slack.com/methods/chat.postMessage](https://api.slack.com/methods/chat.postMessage).

### Creating and instance from Helix UniversalContext

```js
Expand Down
14 changes: 14 additions & 0 deletions packages/spacecat-shared-slack-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ npm install @adobe/spacecat-shared-slack-client
```

## Usage

### Configuring Tokens

To configure tokens for your application, follow these steps:

1. Visit the main page of your Slack app at [https://api.slack.com/apps](https://api.slack.com/apps).

2. Navigate to the "OAuth & Permissions" page and locate the "Scope" section. Here, you can add scopes to your Slack app based on the specific methods you intend to use from the Slack API. For example, if your app requires file upload functionality, ensure you add the `files:read` and `files:write` scopes.

3. Locate your Slack bot token under the "Bot User OAuth Token" section on the same page. You will need to provide this token to the `SlackClient` in your application.

4. For information on the scopes needed for each Slack API method, refer to the [documentation](https://api.slack.com/methods). The required scopes for each API method are listed in the "Bot tokens" row. As an example, to use the `postMessage` API method, the required scope is `chat:write`, as documented in [https://api.slack.com/methods/chat.postMessage](https://api.slack.com/methods/chat.postMessage).


### Creating and instance from Helix UniversalContext

```js
Expand Down

0 comments on commit 77beb5d

Please sign in to comment.