Skip to content

docs: refresh stale README content #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Bccorb merged 1 commit into from
Oct 7, 2026
Merged

docs: refresh stale README content #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

It gives SeamlessAuth a small, explicit way to deliver auth emails and SMS without forcing adopters to rebuild OTP and magic-link flows themselves. SeamlessAuth owns the auth-message defaults; adopters choose transports, handlers, and optional overrides.

For `0.1.0`, the scope is intentionally narrow:
Current scope is intentionally narrow:

- TypeScript packages only
- the three auth flows already used by SeamlessAuth
- the four auth flows SeamlessAuth sends today: email OTP, SMS OTP, magic link email, and passkey enrollment invite email
- AWS SES email
- AWS SNS SMS
- Twilio SMS
Expand Down Expand Up @@ -44,6 +44,7 @@ SeamlessAuth needs to send exactly these auth-related messages today:
- email OTP
- SMS OTP
- magic link email
- passkey enrollment invite email

This repo packages that responsibility into:

Expand All @@ -56,7 +57,7 @@ It is not a general notification platform or a marketing email system.

## Public Model

The intended consumer is a SeamlessAuth server adapter such as `createSeamlessAuthServer(...)`.
The consumer is `seamless-auth-api`, which builds its messaging service from these packages with `createAuthMessagingService(...)` and the AWS and Twilio transports. The `seamless-auth-server` adapters do not depend on these packages.

At integration time, an adopter should be able to provide:

Expand Down Expand Up @@ -116,7 +117,7 @@ await authMessaging.sendOtpSms({

Twilio covers SMS, but not the email flows SeamlessAuth needs for launch.

So `0.1.0` is deliberately channel-based:
So the package family is deliberately channel-based:

- AWS email + AWS SMS
- AWS email + Twilio SMS
Expand Down Expand Up @@ -153,7 +154,6 @@ This package family has also already been used to support a real SeamlessAuth in

This repo was shaped by reviewing and integrating against:

- `seamless-auth-api-internal`
- `seamless-auth-api`
- `seamless-auth-server`

Expand Down
2 changes: 1 addition & 1 deletion packages/aws/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ AWS transport adapters for SeamlessAuth messaging.

New to Seamless Auth? The [self-hosted quickstart](https://docs.seamlessauth.com/start/quickstart/) runs the full stack locally with Docker. If Seamless hosts your auth instance, follow the [managed quickstart](https://docs.seamlessauth.com/start/managed-quickstart/) instead. The [compatibility matrix](https://docs.seamlessauth.com/build/ecosystem/#compatibility-matrix) lists which package versions work together.

`0.1.0` coverage:
Current scope:

- SES for email delivery
- SNS for SMS delivery
Expand Down
1 change: 1 addition & 0 deletions packages/core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This package owns the shared messaging contracts and the auth-focused service su
- OTP email
- OTP SMS
- magic link email
- passkey enrollment invite email (`sendEnrollmentInviteEmail(...)`)

It exposes:

Expand Down
2 changes: 1 addition & 1 deletion packages/twilio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Twilio SMS transport adapter for SeamlessAuth messaging.

New to Seamless Auth? The [self-hosted quickstart](https://docs.seamlessauth.com/start/quickstart/) runs the full stack locally with Docker. If Seamless hosts your auth instance, follow the [managed quickstart](https://docs.seamlessauth.com/start/managed-quickstart/) instead. The [compatibility matrix](https://docs.seamlessauth.com/build/ecosystem/#compatibility-matrix) lists which package versions work together.

`0.1.0` coverage:
Current scope:

- Twilio Programmable SMS for OTP delivery

Expand Down
Loading