Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Xemdo committed Jul 3, 2023
1 parent 76832c2 commit fcf41c5
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ The `api` product enables users to interact with the [Twitch API](https://dev.tw

The format is `api <method> <url> <flags>`.

All commands will exit with code 0 when the command is successful and the HTTP response is 2xx.
Commands will return a non-zero exit code when the command failed, or when the HTTP response is not 2xx (e.g. 400).

## Arguments

All API commands accept one of two formats:
Expand Down
2 changes: 2 additions & 0 deletions docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This should be the first step if the intent is to use either of those functional

If you'd prefer to not use the interactive shell, you can pass the settings via the below flags.

All commands exit the program with a non-zero exit code when the command fails.

**Args**

None.
Expand Down
2 changes: 2 additions & 0 deletions docs/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

The `event` product contains commands to trigger mock events for local webhook testing or migration.

All commands exit the program with a non-zero exit code when the command fails, including when an event does not exist, or when the mock EventSub WebSocket server does not start correctly.

## Trigger

Used to either create or send mock events for use with local webhooks testing.
Expand Down
2 changes: 2 additions & 0 deletions docs/mock-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ The second is the actual server used to mock the endpoints. In the next iteratio

As of the 1.1 release, this product is in an **open beta** and any bugs should be filed via GitHub Issues. Given the breadth of the tool, it is likely you may run across oddities; please fill out an issue if that is the case.

All commands exit the program with a non-zero exit code when the command fails, including when the mock API server fails to start.

## generate

This command will generate a specified number of users with associated relationships (e.g. subscriptions/mods/blocks).
Expand Down

0 comments on commit fcf41c5

Please sign in to comment.