update documentation for v0.11.0 (#34)

* update documentation for v0.11.0 * fix spelling * Update ChangeLog.md Co-authored-by: Liam Cain <[email protected]> * Update README.md Co-authored-by: Liam Cain <[email protected]> * add comment about aur * update changelog * fix linux section * update changelog * Cleanup install instructions. Co-authored-by: Liam Cain <[email protected]> Co-authored-by: Tom Hacohen <[email protected]>
svix · Jul 1, 2021 · eca1a9c · eca1a9c
1 parent 5f4dee1
commit eca1a9c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 6 deletions.
diff --git 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
+* Allows validation of webhook payloads
diff --git 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 <PATH_TO_SVIX_EXE>`),
+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:<PATH_TO_SVIX_EXE>`) 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