Update README.md

This commit is contained in:
Kevin Burnett 2024-03-27 12:25:07 -07:00 committed by GitHub
parent e937c06066
commit 05082b8a00
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions

View File

@ -35,6 +35,8 @@ Health checks are configured for the `spiffworkflow-backend` and `spiffdb` servi
## Interacting with the API
The api is available at localhost:8000/v1.0 if you run `make up` in this repo.
This example uses an approval process to show how to navigate tasks that need to wait for human interaction.
To get an idea of how the process works, you might want to view the diagram and run the process at http://localhost:8001/process-models/approvals:basic-approval before hammering the API.
Some of the followiong commands use `jq`, a useful tool for parsing JSON, in case you want to follow along with that by installing it.