diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b8d691 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Express Build +A simple utility to listen for a Gitea webhook and run a shell script. + +## Setup +1. Copy .env-sample to .env +2. Modify the port to listen on. +3. Add a secret key. +4. Add the path to the shell script to execute. + +## Run +Run `npm install` to setup the dependencies. + +Run `npm run start` to begin listening for webhooks. \ No newline at end of file