Repository navigation
docs: refresh stale README content - #10
Merged
Merged
Conversation
The READMEs described the scope as "0.1.0" while every package is at 0.2.0. Use version-neutral "Current scope" wording so it does not go stale again, and list the passkey enrollment invite email alongside the other flows, since packages/core exports sendEnrollmentInviteEmail. Name seamless-auth-api as the consumer. It builds its messaging service from these packages; seamless-auth-server does not depend on them, and createSeamlessAuthServer(...) never used them. Drop the reference to a private repository from the public README.
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.
Summary
0.1.0" / "0.1.0coverage" (the packages are 0.2.0) becomes version-neutral "Current scope" wording in the root, aws, and twilio READMEs.seamless-auth-apias the consumer, building its service withcreateAuthMessagingService(...)and the AWS and Twilio transports. The API on main imports these insrc/config/directMessaging.tsandsrc/services/messagingService.ts. Theseamless-auth-serveradapters do not depend on these packages.AuthMessagingServiceimplements, adding the passkey enrollment invite email. The core README addssendEnrollmentInviteEmail(...), which is exported on main and used by the API'senrollmentService.ts.Docs only. The root
package.jsonversion is unchanged.Testing
npm run format:check,npm run lint, andnpm test(10 passed) pass.