Repository navigation
docs: rewrite README to reflect current state - #14
Merged
Merged
Conversation
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
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
Rewrites
README.mdto accurately reflect the current@divinevideo/loginAPI and behavior, verified againstsrc/andtests/.Verified changes
getAuthorizationUrl()return — documents{ url, pkce }(previously implied{ url }), and explains when the verifier must be passed toexchangeCode.parseCallback()and handles thecreateRpc()nullcase (noaccess_token), matching the real factory return.onUnauthorizedauto-refresh hook onDivineRpc, wired togetSessionWithRefresh(), with a real usage snippet.Retry-After, 30s request timeouts, and cross-tab refresh serialization via the Web Locks API.refreshSession,getAuthorizationHandle,isExpired,toStoredCredentials,DivineRpc.fromServerUrl,RpcError, and the exportedgeneratePkce/validatePkceutilities and public types.DivineLoginglobal from unpkg/jsDelivr and the@divinevideo/login/browserexport.package.json; CI runs lint, test, and build on Node 22.policy:fulldefault scope,divine_*storage keys, optionalnostr-toolspeer dependency for BYOK, andTokenResponsefields.Kept the existing brand-aligned framing, the
keycast-loginmigration section, and the standard Divine footer.Test plan
Docs-only change. Verified every documented symbol, signature, default, and endpoint against
src/index.ts,src/oauth.ts,src/rpc.ts,src/types.ts,src/pkce.ts,package.json, and.github/workflows/ci.yml.🤖 Generated with Claude Code