Skip to content

Commit

Permalink
docs(fix): include all supported hooks in the list of scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
@zimeg
zimeg committed Mar 21, 2024
1 parent 8cf422a commit 1f28a44
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ invoked.

## Supported Scripts

The hooks currently provided by this repo are `build`, `start`, `check-update`,
`install-update`, `get-trigger`, and `get-manifest`.
The hooks currently provided by this repo are `build`, `check-update`, `doctor`,
`get-hooks`, `get-manifest`, `get-trigger`, `install-update`, and `start`.

| Hook Name | CLI Command | Description |
| ---------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `build` | `slack deploy` | Bundles any functions with Deno into an output directory that's compatible with the Run on Slack runtime. Implemented in `build.ts`. |
| `check-update` | `slack upgrade` | Checks the App's SDK dependencies to determine whether or not any of your libraries need to be updated. Implemented in `check_update.ts`. |
| `doctor` | `slack doctor` | Returns runtime versions and other system dependencies required by the application. Implemented in `doctor.ts`. |
| `doctor` | `slack doctor` | Returns runtime versions and other system dependencies required by the application. Implemented in `doctor.ts`. |
| `get-hooks` | All | Fetches the list of available hooks for the CLI from this repository. Implemented in `mod.ts`. |
| `get-manifest` | `slack manifest` | Converts a `manifest.json`, `manifest.js`, or `manifest.ts` file into a valid manifest JSON payload. Implemented in `get_manifest.ts`. |
| `get-trigger` | `slack trigger create` | Converts a specified `json`, `js`, or `ts` file into a valid trigger JSON payload to be uploaded by the CLI to the `workflows.triggers.create` Slack API endpoint. Implemented in `get_trigger.ts`. |
Expand Down

0 comments on commit 1f28a44

Please sign in to comment.