From 951ed9c36f8f61888701f8897ee86e6673912935 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sun, 1 Mar 2026 17:54:13 +0300 Subject: [PATCH] docs: link to configuration document for overview Signed-off-by: NotAShelf Change-Id: Ie9f7132d784bf0b40e562f3190782fb36a6a6964 --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d5c9111..fae2a98 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,14 @@ $ ./watchdog -config config.yaml ## Configuration +[configuration reference]: docs/configuration.md + +Watchdog currently supports configuration via YAML file, environment variables +or command-line flags. You may find a more complete reference in the +[configuration reference] document. + +### Quick Start + Create `config.yaml`: ```yaml @@ -112,8 +120,6 @@ server: listen_addr: "127.0.0.1:8080" ``` -See [config.example.yaml](config.example.yaml) for all options. - ## Usage ### JavaScript Beacon