From e02c24442561a0beb1a5e286ab0a68618801cbe7 Mon Sep 17 00:00:00 2001
From: Urko <urko@fungimail.com>
Date: Sun, 26 Feb 2023 11:07:21 +0100
Subject: [PATCH] feat: update README

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

diff --git a/README.md b/README.md
index 3f6df21..e8f8432 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # git-webhook-ci
 Tool to automatize your deploy based on file write changes
+## Description
+After some change is made in our listener file the script placed on path set on `env` variable called **WEBHOOK_SCRIPT_PATH** will be executed.
 
 ## Context
 As a security risk that could be allow a webhook listener on a VPS for your git repository, I've decided
@@ -16,3 +18,20 @@ you shold place on your server to run desired tasks. In my case I've done this t
 - [GNU Make 4.3](https://www.gnu.org/software/make/)
 - [goreportcard-cli](https://github.com/gojp/goreportcard)
 - [golangci-lint](https://golangci-lint.run/)
+### Environment Vars
+As shown in .env.example you have to configure this variables in order to make your binary works right:
+```.env
+SCRIPT_BINARY_PATH=/bin/bash
+WEBHOOK_SCRIPT_PATH=/path/to/mybashscript.sh
+FILE_TO_WATCH_PATH=/path/to/myfile.txt
+TEST_FILE_TO_WATCH_PATH=./test_monitor.txt
+```
+
+**TEST_FILE_TO_WATCH_PATH** is needed just to run tests
+
+## How to use
+### Build
+To build you can only just `make build` command
+```bash
+make build
+```
\ No newline at end of file