diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1be208..241c662 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ ## Contributing Contributions are always welcome! -All contributions are required to follow the https://google.github.io/styleguide/go/ + +- **Code style:** Follow the [Google Go Style Guide](https://google.github.io/styleguide/go/). +- **Before submitting:** Run `make test` and `make vet` (or `make lint`) and fix any issues. diff --git a/README.md b/README.md index 7ffab8f..f7ab48b 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,7 @@ When you run `dnsplane client` (or connect over TCP), you get an interactive TUI - **tools** – **dig** (e.g. `tools dig example.com`, `tools dig example.com @8.8.8.8`). - **cache** – List, clear cache. - **stats** – Query counts, cache hits, block list size, runtime stats. +- **statistics** – View aggregated data from the full_stats DB: `statistics requesters [full]` (top requesters by IP, or all with `full`), `statistics domains [full]` (top domains, or all). Requires `full_stats: true` in config. Use `?` or `help` after a command in the TUI for usage. @@ -219,6 +220,8 @@ When the service runs, it will create default `dnsplane.json` and JSON data file - Records from URL or Git (implemented; read-only, with refresh interval) - Server config/set/save and start/stop (dns, api, client) in TUI (implemented) +0.2.x adds shutdown timeouts for systemd, the **statistics** TUI (requesters/domains from full_stats), and build info (Go version, OS, arch) in `stats`. + ## Dependencies & Documentation [![Known Vulnerabilities](https://snyk.io/test/github/network-plane/dnsplane/badge.svg)](https://snyk.io/test/github/network-plane/dnsplane) [![Maintainability](https://qlty.sh/gh/network-plane/projects/dnsplane/maintainability.svg)](https://qlty.sh/gh/network-plane/projects/dnsplane) diff --git a/SECURITY.md b/SECURITY.md index fc36afe..1101490 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Supported Versions -The current main is supported with fixes until an LTS version is release +The current main is supported with fixes until an LTS version is released | Version | Supported | | ------- | ------------------ |