docs: expand README with usage, configuration, and metrics reference#94
Open
ebowman wants to merge 1 commit into
Open
docs: expand README with usage, configuration, and metrics reference#94ebowman wants to merge 1 commit into
ebowman wants to merge 1 commit into
Conversation
The existing README only listed the project name and supported devices. Add installation instructions, CLI flags, Docker usage, router setup guidance, and a full table of exported Prometheus metrics. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
SuperQ
requested changes
Mar 14, 2026
Comment on lines
+23
to
+24
| Multi-arch images are available for `amd64`, `armv7`, and `arm64`. | ||
|
|
Owner
There was a problem hiding this comment.
This isn't needed as the container image has an automatic manifest.
Suggested change
| Multi-arch images are available for `amd64`, `armv7`, and `arm64`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The existing README only listed the project name and supported devices. This makes it easier for new users to get started and understand what metrics are available.
Test plan
main.gocollector.goMakefile🤖 Generated with Claude Code