From 44f050f97d7a9bfabd7efacec6214402b3a0fca5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joan=20Fabr=C3=A9gat?= <joan@codeinc.co>
Date: Thu, 5 Dec 2024 16:54:09 -0800
Subject: [PATCH] Update README.md

---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index 425d17d..e2c3d6b 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,13 @@ Conversion with custom params (page 2 to JPEG with an orange background):
 curl -X POST -F "file=@/path/to/file.pdf" -F "page=2" -F "format=jpg" -F "background=#F60" http://localhost:3000/convert -o example.jpg
 ```
 
+### Health check
+
+A health check is available at the `/health` endpoint. The server returns a status code of `200` if the service is healthy, along with a JSON object:
+```json
+{ "status": "up" }
+```
+
 ## Client
 
 A PHP 8 client is available at on [GitHub](https://github.com/codeinchq/pdf2img-php-client) and [Packagist](https://packagist.org/packages/codeinc/pdf2img-client).