Polish README: badges, ToC, example agents, fix stale claims#67
Merged
Conversation
Adds npm/build/license/node badges and a logo header, a table of contents, and an Example Agents section covering examples/. Corrects the stale "508 tests" figure (now 1,500+ across 88 files), adds the missing hypervault and merge CLI command rows, and links the richer docs (getting-started, CLI reference, architecture, security) and the contributing guide that already existed under docs/ but weren't surfaced.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
tests/project-files.test.ts asserts README.md contains a literal "# AgentVault" markdown heading. Swapping it for a centered HTML <h1> broke that check. Keep the centered logo but use a plain markdown H1 for the title.
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
Reviewed the README against the actual repo state and gave it a polish pass:
site/static/img/logo.svg) and npm version / CI / license / node-engine badges (all backed by real, verified sources —package.json,.github/workflows/test.yml,.github/workflows/release.yml).examples/that weren't previously called out.it(/test(declarations undertests/).hypervaultandmergeCLI commands to the command tables — both are real, registered commands (cli/index.ts) that were missing from the tables.docs/getting-started/*,docs/cli/reference.md,docs/architecture/overview.md, anddocs/security/*, which existed but weren't linked.docs/development/contributing.mdguide from the Contributing section.macos-wallet-app/(the native Xcode wallet companion app) in the project structure tree.No functional/code changes — README only.
Test plan
docs/getting-started/*,docs/cli/reference.md,docs/architecture/overview.md,docs/security/*,docs/development/contributing.md)hypervaultandmergeare real commands registered incli/index.tsgrepovertests/**/*.test.ts(88 files, 1,549it/testdeclarations)release.yml, CI runs viatest.yml,LICENSEis MIT)Generated by Claude Code