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: "" +: "" +: "" +... +``` \ No newline at end of file