docs: point install at the published package, and make the hero command actually run - #10
Merged
Merged
Conversation
…he hero command actually run 0.1.0 is on npm now, so the docs no longer need the pre-publish workaround. Every install instruction pointed at `github:certifieddata/verify` — five in RECEIPT-VERIFICATION.md and the receipt example in the README. That form still works, but it clones and builds rather than fetching 35 kB from the registry, and it is not the command anyone would paste into a terminal on a call. The bigger problem was the hero. It read: npm install -g @certifieddata/verify certifieddata-verify ce_01HXYZ123abc... --dataset path/to/data.csv `ce_01HXYZ123abc...` is not a certificate. Anyone following the README literally — which is the stated bar for this repo — got a failure on the first command they ran, after installing globally to get there. The hero now leads with the zero-install path and two REAL production artifacts, both confirmed working against the published package before being written down: npx --package @certifieddata/verify cd-verify d6da041f-… --type certificate → VALID, signed by ed25519-prod-2025-02 npx --package @certifieddata/verify cd-verify 2492a060-… --type receipt → VALID, settlement succeeded_live Global install is kept, demoted below it, and now shows `cd-verify` with an explicit Windows warning: `verify` is a cmd.exe built-in that shadows the bin and fails silently with exit 1. That is the same trap #7 fixed for the npx form, and the global-install line still had it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
0.1.0 is on npm, so the docs no longer need the pre-publish workaround.
The hero command failed when followed literally
ce_01HXYZ123abc...is not a certificate. Anyone following the README literally — the stated bar for this repo — hit a failure on the first command they ran, after a global install to get there.Now it leads with the zero-install path and two real production artifacts, both confirmed against the published package before being written down:
Five
github:install instructions replacedRECEIPT-VERIFICATION.md(×5) and the README's receipt example still pointed atgithub:certifieddata/verify. That form works but clones and builds instead of fetching 35 kB from the registry, and it is not what anyone pastes into a terminal on a call.The Windows trap was still in the global-install line
#7 fixed this for the npx form but not for
npm install -g.verifyis a cmd.exe built-in that shadows the bin and fails silently with exit 1 — which is exactly how this looked when I first ran the published package. The install section now showscd-verifywith that warning called out.Verified: both documented commands were executed against the published 0.1.0 package, from a clean directory, before this PR was written.
🤖 Generated with Claude Code