Skip to content
This repository has been archived by the owner on Mar 2, 2023. It is now read-only.

Commit

Permalink
chore: add a note to check the JSDoc for options
Browse files Browse the repository at this point in the history
  • Loading branch information
aynh committed Sep 20, 2022
1 parent fcd1343 commit 5968fbe
Showing 1 changed file with 1 addition and 13 deletions.
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,7 @@ crons = ["*/5 * * * *"]

## Options

- `channelIds`\*: Array of Youtube channel's id (e.g. UC-hM6YJuNYVAmUWxeIr9FeA).

- `webhookUrl`\*: Discord Webhook URL, see [Intro to Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks).

- `store`\*: KV Namespace to store the responses.

- `storeKey`\*: Key to be used to store the responses to `store`. It's recommended to have different `storeKey` between different `handle` to avoid conflicts.

- `discord.webhookAvatar`: Avatar to be used when sending webhooks.

- `discord.webhookUsername`: Username to be used when sending webhooks.

- `hooks`: [Hooks](#hooks).
> See the JSDoc [src/types.ts](./src/types.ts)
## Hooks

Expand Down

0 comments on commit 5968fbe

Please sign in to comment.