@synqauth/plugin-magic-link 0.0.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +4 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,11 +4,13 @@ A Synq plugin for email codes and magic links from your own UI.
4
4
 
5
5
  Synq is customer identity for businesses: an OpenID Connect issuer for each of your brands, with Solana wallet, social, email and passkey sign-in. The documentation is at [docs.synq.build](https://docs.synq.build).
6
6
 
7
- This package is at 0.x and hasn't been published yet: its API can change in any release until Synq's first customer depends on it.
7
+ This package is at 0.x, so a minor release can change its API: see its CHANGELOG.md.
8
8
 
9
9
  ## Usage
10
10
 
11
- Email codes and magic links from your own UI: Synq sends the email and checks the code or link. You bring no email transport.
11
+ Start an emailed code or magic link from your own UI: the person types their address on your page, and the brand's hosted page sends the email and takes the code or link. You bring no email transport.
12
+
13
+ To take the code on your own page instead, with no trip to the hosted page, use own-UI sign-in: `useSignIn().emailCode` or `<SignInForm>` from `@synqauth/react`.
12
14
 
13
15
  ```tsx
14
16
  import { magicLinkPlugin } from '@synqauth/plugin-magic-link'
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@synqauth/plugin-magic-link",
3
- "version": "0.0.0",
4
- "description": "A Synq plugin for email codes and magic links from your own UI.",
3
+ "version": "0.3.0",
4
+ "description": "A Synq plugin that sends people from your own UI to the hosted page's emailed code or magic link.",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",