Skip to content

Commit

Permalink
docs: add dev docs to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 30, 2025
1 parent d6e372f commit e57a671
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ if err != nil {
</details>

## Request Payload Examples
## Webhook Request Payload Examples

### Entity Update (updateEntityUrl)

Expand Down Expand Up @@ -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
```

0 comments on commit e57a671

Please sign in to comment.