docs: update README - #1052
Conversation
|
Claude finished @mbevc1's task in 1m 22s —— View job Review: docs: update README
I reviewed this as a docs-only change, so the Go static-analysis phase ( Everything checks out ✅
Earlier feedback resolved: the orphaned PR template reorder moves the "Docs are autogenerated" item to the top — reasonable, since it's the item most likely to be forgotten. Minor optional polish (non-blocking):
Nice work — this turns a one-line README into a genuinely useful front door, and each install path is factually correct against the tooling. No changes requested. |
Expand the minimal root README into a proper front door for the repo: - Turn the one-line description into a short "what it does" overview listing the CLI's key capabilities (fingerprinting, attestations, environment snapshots, compliance assertions). - Add an Installation section with copy-paste blocks for the shell installer, Homebrew, `npm`, Docker, and building from source, plus a note on the available deb/rpm packages. - Keep the existing badges and the four reference links, and continue to link out to the docs site, developer guide, and public trails rather than duplicating them.
Co-authored-by: Marko Bevc <marko.bevc@gmail.com>
Document downloading a prebuilt binary directly from the GitHub Releases page, for users who don't want the install script, a package manager, Docker, or a source build. Includes a Linux amd64 example and the archive naming convention, and points the deb/rpm note at the Releases page where those assets are attached.
The trailing .deb/.rpm + install-docs note sat under "Build from source" and duplicated the .deb/.rpm mention already in "Download a release binary". Move the install-docs link into the release-binary section and drop the orphaned paragraph so Build from source ends at its developer- guide pointer.
Expand the minimal root README into a proper front door for the repo:
npm, Docker, and building from source, plus a note on the available deb/rpm packages.Checklist
charts/k8s-reporter/) updated, if needed. Note: these changes live in a separate PR