From 62327cddcf1c9cea640ce3ead4bc9f0c5f70b3f9 Mon Sep 17 00:00:00 2001
From: didil <1284255+didil@users.noreply.github.com>
Date: Fri, 28 Jun 2024 12:01:25 +0100
Subject: [PATCH] update readme download binaries

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 004b9e3..86318d8 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,17 @@ Inhooks listens to HTTP webhooks and saves the messages to Redis. A processing m
 - Supports message transformation using JavaScript ECMAScript 5.1
 - ... more features planned
 
+## Downloading release binaries
+The release binaries are available on the [GitHub releases](https://github.com/didil/inhooks/releases) page.
+To download a specific version, adjust then env vars below and run:
+```shell
+export INHOOKS_VERSION="0.1.9"
+export OS="linux"
+export ARCH="amd64"
+curl -LO https://github.com/didil/inhooks/releases/download/v${INHOOKS_VERSION}/inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
+tar -xvzf inhooks_${INHOOKS_VERSION}_${OS}_${ARCH}.tar.gz
+```
+
 ## Usage
 ### Inhooks config
 The inhooks config file allows setting up the Source to Sink flows.
@@ -62,6 +73,12 @@ In case of failures, retries are attempted based on the sink config params.
 
 If the config is modifed, the server must be restarted to load the new config.
 
+### Env vars
+Copy the .env examples to init the .env file and update as needed (to set the inhooks config file path, the redis url, the server port, etc).
+```shell
+cp .env.example .env
+```
+
 ### Securing webhooks
 If you would like to verify your webhooks with HMAC 256, you can use the following configuration: