From ce41312801427d39a2ddf2c3d2cd0754bb87f703 Mon Sep 17 00:00:00 2001 From: constantstress <149433905+constantstress@users.noreply.github.com> Date: Sun, 31 Dec 2023 03:59:54 +0300 Subject: [PATCH] Updated examples in event.md Changed golang style comments to sh style comments in examples `//` to `#` --- docs/event.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/event.md b/docs/event.md index b431237..9a88cb1 100644 --- a/docs/event.md +++ b/docs/event.md @@ -116,10 +116,11 @@ This command can take either the Event or Alias listed as an argument. It is pre | `--to-user` | `-t` | Denotes the receiver's TUID of the event, usually the broadcaster. | `-t 44635596` | N | | `--transport` | `-T` | The method used to send events. Can either be `webhook` or `websocket`. Default is `webhook`. | `-T webhook` | N | +**Examples** ```sh -twitch event trigger subscribe -F https://localhost:8080/ // triggers a randomly generated subscribe event and forwards to the localhost:8080 server -twitch event trigger cheer -f 1234 -t 4567 // generates JSON for a cheer event from user 1234 to user 4567 +twitch event trigger subscribe -F https://localhost:8080/ # triggers a randomly generated subscribe event and forwards to the localhost:8080 server +twitch event trigger cheer -f 1234 -t 4567 # generates JSON for a cheer event from user 1234 to user 4567 ``` ## Retrigger @@ -156,7 +157,7 @@ None **Examples** ```sh -twitch event retrigger -i "713f3254-0178-9757-7439-d779400c0999" -F https://localhost:8080/ // triggers the previous cheer event to localhost:8080 +twitch event retrigger -i "713f3254-0178-9757-7439-d779400c0999" -F https://localhost:8080/ # triggers the previous cheer event to localhost:8080 ``` ## Verify-Subscription @@ -180,7 +181,7 @@ This command takes the same arguments as [Trigger](#trigger). **Examples** ```sh -twitch event verify-subscription cheer -F https://localhost:8080/ // triggers a fake "cheer" EventSub subscription and validates if localhost responds properly +twitch event verify-subscription cheer -F https://localhost:8080/ # triggers a fake "cheer" EventSub subscription and validates if localhost responds properly ``` ## WebSocket @@ -220,4 +221,4 @@ twitch event websocket reconnect twitch event websocket close --session=e411cc1e_a2613d4e --reason=4006 twitch event websocket subscription --status=user_removed --subscription=82a855-fae8-93bff0 twitch event websocket keepalive --session=e411cc1e_a2613d4e --enabled=false -``` \ No newline at end of file +```