From d76a295bb37fb71f5648dafa55abfd47e144bd4d Mon Sep 17 00:00:00 2001
From: Lu Baumann <mail@lu-dev.de>
Date: Wed, 13 Dec 2023 04:50:13 +0100
Subject: [PATCH] updated readme

---
 README.md | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 24de12d..db23731 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
 # docker-healthcheck
 
-Healthchecks integration for docker containers
\ No newline at end of file
+Healthchecks integration for docker containers
+
+Configuration is specified in "checks.yaml" in your working directory.
+The format of "checks.yaml" looks like the following:
+
+```
+self: "<ping url>"
+<docker container id or name 1>: "<ping url>"
+<docker container id or name 2>: "<ping url>"
+...
+```
\ No newline at end of file