From 28abcf50e2702b1d04fd10f3f36ccac9f5474209 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sun, 1 Mar 2026 01:11:53 +0300 Subject: [PATCH] docs: improve introduction paragraph; tiny cleanup Signed-off-by: NotAShelf Change-Id: I2d331809c915f4695603b72ff52857cc6a6a6964 --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9c81d6f..ce5a28c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Watchdog -Privacy-preserving web analytics with Prometheus-native metrics. +Watchdog is a privacy-preserving web analytics platform similar to Plausible, +where data visualisation is deferred to a Prometheus-compatible dashboard such +as Grafana. It is designed to be as simple and lightweight as possible, without +any additional web components to worry about. You, in turn, get to use your +existing monitoring stack to also collect information about your web +applications tracked by Watchdog. ## Design @@ -13,6 +18,9 @@ Privacy-preserving web analytics with Prometheus-native metrics. ## Quick Start ```bash -go build -o watchdog ./cmd/watchdog -./watchdog --config config.yaml +# Build the prıject +$ go build -o watchdog ./cmd/watchdog + +# Start the Watchdog daemon with your own config +$ ./watchdog --config config.yaml ```