TiagoRG
/
gh-wh-handler
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Tiago Garcia 2024-07-14 22:32:17 +01:00
parent 9dd35b2ec0
commit 57c4109e19
Signed by: TiagoRG
GPG Key ID: DFCD48E3F420DB42
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -6,6 +6,19 @@ Currently creating a local copy of remote files on every push
## Usage
### Run prebuilt binary
Head over to the [Releases Page](https://github.com/TiagoRG/gh-wh-handler/releases) and download the desired binary.
Run the application using your configuration file:
```console
/path/to/gh_wh_handler_<arch> /path/to/config.json
```
You can see the config file format below.
### Run from source
Install the dependencies:
- [CrowCpp](https://crowcpp.org/master/)
@ -18,7 +31,7 @@ make
Run the application using your configuration file:
```console
./gh_wh_handler /path/to/config.json
bin/gh_wh_handler /path/to/config.json
```
Note: default config file path is `/etc/gh_wh_handler/config.json`