diff --git a/README.md b/README.md index 3dcf02a..ebe77c0 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,24 @@ COMPOSE_FILE="compose.yml:compose.auth.yml:compose.private.yml" ``` +## Usage + +To trigger the deploy webhook with normal HTTP request + +```bash +curl -v -XPOST https://example.org/deploy +``` + +To trigger the deploy webhook with HTTP Auth enabled, add the header with: + +```bash +curl -v XPOST -H "Authorization: Basic " https://hook.com/deploy +``` + +Assuming all is setup correctly, you should see the build triggered +when viewing `abra app log example.org` log output. + + ## Troubleshooting This is a WIP, there are likely dragons and foot cannons. Ye be warned :dragon: :pirate_flag: :grimacing: