From c7e5c03239a909240e95fb78a95be81de59a298a Mon Sep 17 00:00:00 2001 From: clawbot Date: Sun, 1 Mar 2026 07:51:39 -0800 Subject: [PATCH] Update README for REPO_POLICIES compliance - Add project description first line with name, purpose, category, author - Replace CONVENTIONS.md reference with REPO_POLICIES.md - Add License section (pending author choice) - Add Author section --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0a9d555..11e0819 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # dnswatcher +dnswatcher is a pre-1.0 Go daemon by [@sneak](https://sneak.berlin) that monitors DNS records, TCP port availability, and TLS certificates, delivering real-time change notifications via Slack, Mattermost, and ntfy webhooks. + > ⚠️ Pre-1.0 software. APIs, configuration, and behavior may change without notice. -dnswatcher is a production DNS and infrastructure monitoring daemon written in -Go. It watches configured DNS domains and hostnames for changes, monitors TCP +dnswatcher watches configured DNS domains and hostnames for changes, monitors TCP port availability, tracks TLS certificate expiry, and delivers real-time notifications via Slack, Mattermost, and/or ntfy webhooks. @@ -385,7 +386,18 @@ docker run -d \ ## Project Structure -Follows the conventions defined in `CONVENTIONS.md`, adapted from the +Follows the conventions defined in `REPO_POLICIES.md`, adapted from the [upaas](https://git.eeqj.de/sneak/upaas) project template. Uses uber/fx for dependency injection, go-chi for HTTP routing, slog for logging, and Viper for configuration. + +--- + +## License + +License has not yet been chosen for this project. Pending decision by the +author (MIT, GPL, or WTFPL). + +## Author + +[@sneak](https://sneak.berlin)