From eca1a9c7578c0ca43d74e1b16efc0eefb1b3836a Mon Sep 17 00:00:00 2001 From: Frank <84723448+svix-frank@users.noreply.github.com> Date: Thu, 1 Jul 2021 12:22:09 -0400 Subject: [PATCH] update documentation for v0.11.0 (#34) * update documentation for v0.11.0 * fix spelling * Update ChangeLog.md Co-authored-by: Liam Cain <84334931+svix-liam@users.noreply.github.com> * Update README.md Co-authored-by: Liam Cain <84334931+svix-liam@users.noreply.github.com> * add comment about aur * update changelog * fix linux section * update changelog * Cleanup install instructions. Co-authored-by: Liam Cain <84334931+svix-liam@users.noreply.github.com> Co-authored-by: Tom Hacohen --- ChangeLog.md | 8 +++++++- README.md | 24 +++++++++++++++++++----- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 8c580e0..103985d 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -1,5 +1,11 @@ # Changelog +## Version 0.11.0 +* Add `listen` command for testing webhook receivers locally +* Bump svix-libs to v0.18.0, allows webhook verifying with prefixed secrets +* Don't html escape when printing json output, fixes dashboard urls +* Initial snap release! + ## Version 0.10.0 * print response body to stdin on api errors @@ -27,4 +33,4 @@ ## Version 0.0.0 (Initial release) * Allows interaction with the Svix API -* Allows validation of webhook payloads \ No newline at end of file +* Allows validation of webhook payloads diff --git a/README.md b/README.md index a7d44f0..1b6015d 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,27 @@ scoop bucket add svix https://github.com/svix/scoop-svix.git scoop install svix ``` -### Other +### Linux -If you are on another platform such as linux or just rather not use a package manager, you can download a binary from our Github releases and use it straight away without having to install any additional dependencies. -1) Find the latest release, download the tar.gz file for your given operating system and extract it. -2) Inside you'll find the `svix` executable which you can run directly (Note: you may need to allow execution via `chmod +x `), +The Svix CLI is available on Linux via: -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:`) Otherwise, simply `cd` to the folder where you extracted the tar.gz file and run it with ./svix. +* The [Snap Store](https://snapcraft.io): `snap install svix` +* The [Arch User Repository (AUR)](https://wiki.archlinux.org/title/Arch_User_Repository): `yay -S svix-cli` +* For Ubuntu/Debian: get the `deb` package from [our Github releases page](https://github.com/svix/svix-cli/releases) +* For Fedora/CentOS: get the `rpm` package from [our Github releases page](https://github.com/svix/svix-cli/releases) + + +### Pre-built executables + +You can download and use our pre-built executables directly from [our releases page](https://github.com/svix/svix-cli/releases), and use them as is without having to install anything. + +1. Download and extract the `tar.gz` archive for your operating system. +2. Run the `svix` executable from the command line: `./svix help`. + +Note: you may need to allow execution by running `chmod +x svix`. + + +You can also put the binaries anywhere in your `PATH` so you can run the command from anywhere without needing to provide its full path. On macOS or Linux you can achieve this by moving the executable to `/usr/local/bin` or `/usr/bin`. ## Usage