NotAShelf/watchdog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: improve introduction paragraph; tiny cleanup

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I2d331809c915f4695603b72ff52857cc6a6a6964
This commit is contained in:
raf 2026-03-01 01:11:53 +03:00
commit 28abcf50e2
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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
```