update readme

svix · Jun 2, 2021 · dc9b57f · dc9b57f
1 parent ac0dc42
commit dc9b57f
Showing 1 changed file with 22 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -4,11 +4,12 @@
 
 A CLI to interact with the Svix API.
 
-**With the CLI, you can:**
+**With the Svix CLI, you can:**
 
 - Interact with the Stix CLI
 - Validate Webhook payloads
 
+
 ## Installation
 
 Homebrew Tap & Scoop Bucket Coming soon.
@@ -19,6 +20,7 @@ For now, you can download the binary executable and use it straight away without
 
 On macOS or Linux, you can move this file to `/usr/local/bin` or `/usr/bin` locations to have it be runnable from anywhere; or place it anywhere and add it to your path (ex. `export PATH=$PATH:<PATH_TO_SVIX_EXE>`) Otherwise, simply `cd` to the folder where you extracted the tar.gz file and run it with ./svix.
 
+
 ## Usage
 
 Installing the Svix CLI provides access to the `svix` command.
@@ -33,6 +35,7 @@ svix help
 svix [command] --help
 ```
 
+
 ## Quick Start
 
 ```sh
@@ -49,33 +52,34 @@ svix application create --name demo
 svix application list --limit 2 --iterator some_iterator 
 ```
 
+
 ## Commands
 
 The Svix CLI supports the following commands:
- - init            Interactively configure your Svix API credentials
- - application     List, create & modify applications
- - authentication  Manage authentication tasks such getting dashboard urls
- - endpoint        List, create & modify endpoints
- - event-type      List, create & modify event types
- - message         List & create messages
- - message-attempt List, lookup & resend message attempts
- - verify          Verify the signature of a webhook message
- - version         Get the version of the Svix CLI
- - help            Help about any command
+| Command         | Description                                             |
+| --------------- | ------------------------------------------------------- |
+| init            | Interactively configure your Svix API credentials       |
+| application     | List, create & modify applications                      |
+| authentication  | Manage authentication tasks such getting dashboard urls |
+| endpoint        | List, create & modify endpoints                         |
+| event-type      | List, create & modify event types                       |
+| message         | List & create messages                                  |
+| message-attempt | List, lookup & resend message attempts                  |
+| verify          | Verify the signature of a webhook message               |
+| version         | Get the version of the Svix CLI                         |
+| help            | Help about any command                                  |
 
-## Documentation
-
-For a more information, checkout our [API reference](https://docs.svix.com)
 
+## Documentation
 
-![demo](docs/demo.gif)
+For a more information, checkout our [API reference](https://docs.svix.com).
 
 
 ### Development
 
 #### Building the current commit
 
 This project uses [goreleaser](https://github.com/goreleaser/goreleaser/)
- 1) Install [go](https://golang.org/doc/install)
- 2) Install goreleaser via the steps [here](https://goreleaser.com/install/)
- 3) Build current commit via `goreleaser release --snapshot --skip-publish`
+ 1) Install [go](https://golang.org/doc/install).
+ 2) Install goreleaser via the steps [here](https://goreleaser.com/install/).
+ 3) Build current commit via `goreleaser release --snapshot --skip-publish`.