docs(readme): refresh homepage to house brand structure - #1
Merged
Merged
Conversation
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
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.
What changed
Visual refresh of the README to match the house brand structure used across the other repos (spookyjuice.ai, spookywrt, gmail-cleanup, etc.). No content rewrite -- the existing copy and tables are kept; the page is reordered and decorated with verifiable proof up front.
ci-typescript.ymlworkflow), npm version (published@bgorzelic/ghostlink@0.1.0), TypeScript strict, Node >= 18 (.nvmrc/engines), tests (108 -- verified by running the suite), ISC license (LICENSE file).npx -y @bgorzelic/ghostlink.mcp.jsonsnippet (the published package exposes theghostlinkbin, so this is mechanically valid), followed immediately by the realToolEnvelopeJSON as proof before the long explanation.Why
The README had strong copy but buried the proof and the fastest install path below two screens of explanation, and repeated the same config block three times. This brings it in line with the proof-before-explanation structure of the other repo homepages and makes it shorter (76 insertions / 90 deletions).
Facts
No facts were added or invented. Every badge and claim was verified against the repo before inclusion: the test count by running
npm test(108 passed), the npm badge against the live registry, the envelope shape againstsrc/types/envelope.ts, and the audit-log table againstsrc/core/logging/audit.ts.