Skip to content

docs: update README - #1052

Merged
mbevc1 merged 6 commits into
mainfrom
20260728_readme
Jul 28, 2026
Merged

docs: update README#1052
mbevc1 merged 6 commits into
mainfrom
20260728_readme

Conversation

@mbevc1

@mbevc1 mbevc1 commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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.
  • re-order PR template

Checklist

@mbevc1 mbevc1 added the documentation Improvements or additions to documentation label Jul 28, 2026
@mbevc1
mbevc1 enabled auto-merge (squash) July 28, 2026 15:22
@claude

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 1m 22s —— View job


Review: docs: update README

  • Read PR diff and current README
  • Verify install commands against the repo
  • Confirm earlier deb/rpm feedback was addressed
  • Post review

I reviewed this as a docs-only change, so the Go static-analysis phase (go build / go vet / go mod tidy) doesn't apply — no code changed. I focused on whether the new install instructions are accurate and consistent with the repo, and cross-checked each one:

Everything checks out ✅

Section Verified against
Install script + sh -s -- v<X.Y.Z> install-cli.sh parses a positional version arg and strips the leading v (VERSION_FILENAME=$(echo "$VERSION" | sed 's/^v//')), so the tag form is correct.
Release-binary archive naming (kosli_<X.Y.Z>_<os>_<arch>.tar.gz / .zip) Matches the download URL the script builds exactly.
brew install kosli-cli / brew upgrade kosli-cli Matches formula name in install-cli.sh, and CI runs the identical command (.github/workflows/install-script-tests.yml:64) with no tap step — so the bare command is right.
npm install -g @kosli/cli + the "no npx" caveat Package name matches npm/wrapper/package.json; the esbuild-style optionalDependencies pattern (npm/README.md) is exactly why npx skips the platform binary. Good, non-obvious detail to call out.
Docker ghcr.io/kosli-dev/cli Consistent with the release pipeline.

Earlier feedback resolved: the orphaned .deb/.rpm note that was previously sitting under Build from source has been folded into Download a release binary (README.md:61) in commit c878b8c2, and the duplicate is gone. 👍

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):

  • The badges (line 1–4) don't include the license row's alt-text issue or anything — no action needed.
  • Consider whether the Install script section should note it installs into a PATH dir that may require sudo (the script picks a target dir automatically), but this is already implied and the docs link covers the full detail.

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.
· 20260728_readme

Comment thread README.md Outdated
Comment thread README.md Outdated
@mbevc1
mbevc1 force-pushed the 20260728_readme branch from 21a9c6b to b487309 Compare July 28, 2026 15:34
Comment thread README.md Outdated
mbevc1 and others added 6 commits July 28, 2026 16:42
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.
@mbevc1
mbevc1 force-pushed the 20260728_readme branch from b757cdd to c878b8c Compare July 28, 2026 15:42
@mbevc1
mbevc1 merged commit 6a9ea8a into main Jul 28, 2026
20 checks passed
@mbevc1
mbevc1 deleted the 20260728_readme branch July 28, 2026 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants