docs: Adding /ready endpoint documentation

Signed-off-by: Vincent Boutour <[email protected]>
ViBiOh · Apr 5, 2021 · e2d3a4b · e2d3a4b
1 parent 4243b1f
commit e2d3a4b
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,7 @@ You'll find a Kubernetes exemple in the [`infra/`](infra/) folder, using my [`ap
 ## Endpoints
 
 - `GET /health`: healthcheck of server, respond [`okStatus (default 204)`](#usage) or `503` during [`graceDuration`](#usage) when SIGTERM is received
+- `GET /ready`: same response than `/health` but it also checks external dependencies availability
 - `GET /version`: value of `VERSION` environment variable
 - `GET /metrics`: Prometheus metrics values