feat: update README

This commit is contained in:
Urko. 2024-04-29 21:52:15 +02:00
parent ad77710ad1
commit 091ad1fec0
1 changed files with 6 additions and 9 deletions

View File

@ -4,7 +4,7 @@ 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.
After some change is made in our listener file the script placed on path set on `.yaml` variable called **webhook_script_path** will be executed.
## Context
@ -21,24 +21,21 @@ you shold place on your server to run desired tasks. In my case I've done this t
### Requirements
- [Go version > 1.19](https://go.dev/dl/)
- [Go version > 1.22](https://go.dev/dl/)
- [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:
As shown in app.example.yml 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
script_binary_path: "/bin/bash"
webhook_script_path: "./test-script.sh"
file_to_watch_path: "./test_monitor.txt"
```
**TEST_FILE_TO_WATCH_PATH** is needed just to run tests
## How to use
### Build