Skip to content

Update README for interact() and version 4.1.#59

Merged
dlongley merged 2 commits into
mainfrom
update-readme-interact
Jul 2, 2026
Merged

Update README for interact() and version 4.1.#59
dlongley merged 2 commits into
mainfrom
update-readme-interact

Conversation

@djscruggs

Copy link
Copy Markdown
Contributor

What

  • Bump the recommended install version in the README from 3.x to 4.1 (unpkg <script> tag and package.json snippet).
  • Move the deprecated get()/store() walkthrough (get(), store(), WebCredential, Handling Empty Results) out of the README into docs/get-store.md; the README keeps a short deprecation callout that links to it for existing integrations.
  • Link "interaction URL" to the VCALM specification (Interaction URL Format) in the interact() section and the deprecation callout.
  • Update the "Advanced Operations for Wallet Providers" intro: relying parties use interact() now, and wallet providers do not call navigator.credentials at all — registration uses CredentialManager.requestPermission() (which goes through navigator.credentialsPolyfill.permissions), and handlers receive requests via events or a protocols query parameter. This means a future removal of the navigator.credentials patching is a no-op for wallets.

Notes

  • Docs-only change; no source or test changes.
  • The "Features" section and the interact() under-the-hood paragraph still reference navigator.credentials.get()/store() — accurate for the current implementation; they should be revisited when the navigator.credentials patching is actually removed.
  • CI runs lint (Node 22.x) and the Playwright test matrix; both npm run lint and npm test pass locally (20 passed, 1 skipped WebKit case).

🤖 Generated with Claude Code

Move the deprecated get()/store() instructions to docs/get-store.md
and link to them from the README. Link "interaction URL" to the VCALM
specification. Bump the recommended install version from 3.x to 4.1.
Clarify that wallet providers do not call navigator.credentials;
registration uses CredentialManager.requestPermission() and handlers
receive requests via events or a protocols query parameter.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@djscruggs
djscruggs marked this pull request as ready for review July 2, 2026 19:21
@djscruggs
djscruggs requested a review from dlongley July 2, 2026 19:21
Comment thread docs/get-store.md Outdated
@dlongley
dlongley merged commit ff822cc into main Jul 2, 2026
2 checks passed
@dlongley
dlongley deleted the update-readme-interact branch July 2, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants