diff --git a/README.md b/README.md index 068205f..27b5b10 100644 --- a/README.md +++ b/README.md @@ -141,7 +141,7 @@ if err != nil { -## Request Payload Examples +## Webhook Request Payload Examples ### Entity Update (updateEntityUrl) @@ -259,3 +259,20 @@ async def update_entity_status_in_fmtm( log.warning(msg) raise HTTPException(status_code=400, detail=msg) ``` + +## Development + +- This package mostly uses the standard library, plus a Postgres driver +and testing framework. +- Binary and container image distribution is automated on new **release**. + +### Run The Tests + +The test suite depends on a database, so the most convenient way is to run +via docker. + +There is a pre-configured `compose.yml` for testing: + +```bash +docker compose run --rm webhook +```