Add usage instructions

This commit is contained in:
Felix Niederwanger 2022-02-08 11:50:38 +01:00
parent 2cb91cadb2
commit a5521a994d
Signed by: phoenix
GPG key ID: 31860289A704FB3C

View file

@ -1,5 +1,18 @@
# weblug
Easy automation of webhooks.
weblug is the counter-part for web-hooks that allows custom programs and scripts to be executed when a configurable webook is triggered.
Simple webhook receiver program.
weblug is the counter-part for web-hooks that allows custom programs and scripts to be executed when a configurable webook is triggered.
## Usage
To use `weblug` you need to define webooks in a yaml file. See [weblug.yaml](weblug.yaml) for an example configuration. Then run
./weblug YAML-FILE
This starts the webserver and listens for incoming webhooks.
## Build
make # Build weblug
make static # Make a static binary