docs: refresh the README to the shipped engine - #35
Merged
Merged
Conversation
The front matter still announced v0.2.0 eight releases after it, and the repository badges pointed at the pre-rename owner. Retire the version-pegged section: the scope paragraph moves into "What it checks" as its own subsection, and the flag list and sample score it carried were already duplicated verbatim further down. The rule table said ten categories and 24 rules; DefaultRegistry() registers eleven groups and 25 rules, and SD-025 Reverse Shell had no row at all. The Go module path, the Homebrew tap owner and the Go Report Card badge stay on velzepooz — the module path is what go.mod declares, and the tap asymmetry is deliberate (docs/runbooks/release.md). Claude-Session: https://claude.ai/code/session_01T8VRxMK2v8hcmomWw9uWxk
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
1 participant
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.
The README's front matter still announced "What's new in v0.2.0", eight
releases after it, and the repository badges pointed at the pre-rename owner.
It is the first thing anyone sees, and it read as abandoned.
What changed
describing what the scanner actually reads — moves into "What it checks" as
its own
### Scope — which files are readsubsection. The flag list and thesample Trust Score it also carried were already duplicated verbatim further
down in Usage and in "Trust Score (sample output)", so they are simply gone.
A single line now points at the CHANGELOG for what changed in each release,
which does not go stale.
total)". Running
DefaultRegistry()reports eleven groups and 25 rules,and SD-025 Reverse Shell had no row at all. Both fixed.
*(new in v0.2)*/*(new)*markers from the tableand from a usage comment. Everything they marked has been shipped for
several releases.
skilltrust: the CI, Release and GoVersion badges, and the links to Releases and to the private security
advisory form.
What deliberately still says
velzepoozThree references, all correct as they stand:
go install github.com/velzepooz/skill-detector/...— that is the modulepath
go.moddeclares.brew install velzepooz/tap/skill-detector— the cask lives invelzepooz/homebrew-tap, and the release runbook records that asymmetry asintentional rather than a leftover to "fix" mid-release.
Testing
go build ./...and the full suite pass (1085 tests). The workspace'smake verify-clonewas run against this branch rather than the defaultcheckout — it clones the repository and checks that the public set is present,
the local-only set absent, no forbidden token survives and no relative link is
dead. Result:
clones clean.https://claude.ai/code/session_01T8VRxMK2v8hcmomWw9uWxk