Repository navigation
docs: make the registry-to-verified-BTC workflow clear - #13
Merged
Merged
Conversation
Codex-Session: verity-discoverability-20261017
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 changes
The README previously led with tool details, unpinned install commands, and a stale statement that npm 1.3.1 was not yet published. This change puts a complete first-use workflow first: install the registry-listed npm package, request a keyless BTC sample, and verify the unchanged signed receipt.
It also links prominently to the GitHub MCP listing, explains keyless versus developer access, pins the README's stdio examples to npm 1.3.1, and clarifies signature coverage, the public-key fetch, and the separate hosted-service lifecycle. Detailed integration and signature documentation remains available below the quickstart.
Only README.md changes. No runtime, dependency, package version, manifest, billing, or registry-record changes are included.
Publication and configuration verification
io.github.PulseBet/pulse-verity.pulse-verity@1.3.1.Validation
git diff --check: passed.node scripts/words-test.mjs: passed (5 surfaces).dist/index.js. No local production build was run; these are not successful packaging checks.valid: trueandrecordValid: true. No feedback report was submitted.Cloud checks on commit
8ad718f922fbaed05c91ef55f09880d40c9160b5have completed:Release boundary
Draft for review only: do not merge, publish npm, deploy a service, or modify registry records as part of this task. A separate registry-copy correction and a decision about the metadata-version validator remain outstanding. A future npm release would be needed only to distribute the revised README inside the npm package itself; this PR does not require an npm publication to update the GitHub README after approval and merge.