docs(readme): lead with End-Cell (recommended) + bump 1.4.0#9
Merged
Conversation
…y warning on createIntent - Quick start rewritten around createEndCellIntent + verifyIntent rail flow - 'Building a verification URL' section: verify.keyhalve.com + base64url fragment - 'End-Cell (recommended)' API section; rail options in the client table - explicit warning: this SDK's createIntent is the legacy FULL-single-key flow (no key split at all, unlike Node/Python) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
… origin Co-Authored-By: Claude Fable 5 <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.
The README never mentioned End-Cell even though the SDK has had
createEndCellIntent(src/client.ts:186) since 2026-06-21, and the published npm version (1.3.0, 2026-06-19) predates it entirely.README (mirrors node PR #16's structure)
createEndCellIntent→verifyIntent(rail share fetched from the independent KeyHalve rail, Ed25519 signature verified against a pinned key, fail-closed).https://verify.keyhalve.com/verify/<id>#key=<base64url ShareA>.railBaseUrl/railPublicKeySpkidocumented in the client options table.createIntentis the legacy FULL-single-key flow — no key split at all (the returnedkeyis the complete AES key). Node/PythoncreateIntentdefault to 2-share split-key; here the 2-share option iscreateSplitKeyIntent(not deprecated in this SDK).Version bump (included here since published 1.3.0 lacks End-Cell)
package.json1.3.0 → 1.4.0 + CHANGELOG entry (End-Cell issuance + rail verify, canonical verify origin, End-Cell-first README).v1.3.0tag'ssrc/client.tscontains nocreateEndCellIntent, so the npm publish must be a new version.Checks
npm ci+npm test: 100/100 passed locally.package-lock.jsonchanges.Publish stays Mike-gated per release — do not merge/tag/publish without explicit go.
🤖 Generated with Claude Code