Skip to content

Commit 496cd48

Browse files
authored
chore(docs): small README updates
1 parent ca13b54 commit 496cd48

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
[![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ)
66

7-
Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local webserver. We offer unlimited **free** and **permanent** event URLs. Your event history is preserved between sessions and can be viewed, replayed, or used for testing by you and your teammates.
7+
Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local web server with unlimited **free** and **permanent** event URLs. Your event history is preserved between sessions and can be viewed, replayed, or used for testing by you and your teammates.
88

99
Hookdeck CLI is compatible with most of Hookdeck's features, such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your event (e.g. webhook) integration code locally.
1010

1111
Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions.
1212

13-
Hookdeck for development is completely free, and we monetize the platform with our Production offering.
13+
Hookdeck for development is completely free, and we monetize the platform with our production offering.
1414

15-
For a complete reference, see the [CLI reference](https://hookdeck.com/cli?ref=github-hookdeck-cli)
15+
For a complete reference, see the [CLI reference](https://hookdeck.com/docs/cli?ref=github-hookdeck-cli).
1616

1717
https://github.com/hookdeck/hookdeck-cli/assets/328367/a49dcf59-49ee-4838-9643-b6f90d2ab33e
1818

@@ -45,7 +45,7 @@ scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git
4545
scoop install hookdeck
4646
```
4747

48-
### Linux Or Without package managers
48+
### Linux Or without package managers
4949

5050
To install the Hookdeck CLI on Linux without a package manager:
5151

@@ -112,7 +112,7 @@ Hookdeck works by routing events received for a given `source` (i.e., Shopify, G
112112

113113
Each `source` is assigned a Event URL, which you can use to receive events. When starting with a fresh account, the CLI will prompt you to create your first source. Each CLI process can listen to one source at a time.
114114

115-
Contrary to ngrok, **Hookdeck does not allow to append a path to your enent URL**. Instead, the routing is done within Hookdeck configuration. This means you will also be prompted to specify your `destination` path, and you can have as many as you want per `source`.
115+
Contrary to ngrok, **Hookdeck does not allow to append a path to your event URL**. Instead, the routing is done within Hookdeck configuration. This means you will also be prompted to specify your `destination` path, and you can have as many as you want per `source`.
116116

117117
> The `port-or-URL` param is mandatory, events will be forwarded to http://localhost:$PORT/$DESTINATION_PATH when inputing a valid port or your provided URL.
118118

0 commit comments

Comments
 (0)