Reorder README to lead with interact().#58
Merged
Conversation
Promote interact() to the recommended relying-party entry point, directly after polyfill loading, and move get()/store() into a clearly deprecated section below it. Explain that an interaction URL covers credential request, storage, or both -- the operation is deferred to the exchange layer and is never expressed to or via CHAPI -- so callers no longer make the get/store distinction. Documentation only; the code does not yet mark get()/store() deprecated. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Wrap loadOnce() examples in try/catch, add a setGlobal: false load example, tighten the interact() intro wording, and expand the interactionUrl comment to explain trusted-origin and TLS-authentication behavior. Addresses review comments on PR #58. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dlongley
approved these changes
Jun 26, 2026
dlongley
reviewed
Jun 26, 2026
dlongley
reviewed
Jun 26, 2026
djscruggs
added a commit
that referenced
this pull request
Jun 26, 2026
Wrap loadOnce() examples in try/catch, add a setGlobal: false load example, tighten the interact() intro wording, and expand the interactionUrl comment to explain trusted-origin and TLS-authentication behavior. Addresses review comments on PR #58. Co-Authored-By: Claude Opus 4.8 (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
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
Reorders the README so
interact()is presented as the recommendedrelying-party entry point, with
get()/store()moved into a clearlydeprecated section below it. Follow-up to the merged
interact()PR (#57).What changed
interact()promoted to directly after "Loading the Polyfill" and framedas the recommended path for issuers and verifiers.
get()/store()marked deprecated in a dedicated section, with acallout pointing readers to
interact(). WebCredential and "Handling EmptyResults" move down with them.
requestPermission())left as-is — not deprecated; wallet registration is unaffected.
both: the operation is deferred to the exchange layer and is never expressed
to or via CHAPI, so callers no longer make the get/store distinction.
interact()always generates a request" wording, whichcontradicted the get-or-store-or-both behavior.
Scope
Documentation only. The code does not yet mark
get()/store()asdeprecated — that is intentionally deferred to a later change. "Load the
polyfill first" guidance is preserved.
🤖 Generated with Claude Code