Skip to content

Commit 1f53d71

Browse files
committed
removing references to "Lightning" in favour of references to "Pubkey"
1 parent e55e73b commit 1f53d71

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ openssl rand -base64 32
6666

6767
Create a new API route under `pages/api/pubkey/[...pubkey].ts`
6868

69-
This API will handle all of the Lightning auth API requests, such as generating QRs, handling callbacks, polling and issuing JWT auth tokens.
69+
This API will handle all of the pubkey auth API requests, such as generating QRs, handling callbacks, polling and issuing JWT auth tokens.
7070

7171
```typescript
7272
// @/pages/api/pubkey/[...pubkey].ts
@@ -105,7 +105,7 @@ export default handler;
105105
106106
### Provider
107107

108-
In your existing `pages/api/auth/[...nextauth].ts` config file, import and add the Lightning provider to the provider array.
108+
In your existing `pages/api/auth/[...nextauth].ts` config file, import and add the provider to the providers array.
109109

110110
```typescript
111111
// @/pages/api/auth/[...nextauth].ts
@@ -159,15 +159,15 @@ const config: NextAuthPubkeyConfig = {
159159
* @param {string} secret
160160
*
161161
* Must be defined as a securely generated random string. Used to sign the
162-
* JWT token that authenticates users who have logged in with Lightning.
162+
* JWT token that authenticates users who have logged in.
163163
*/
164164
secret: process.env.NEXTAUTH_SECRET,
165165

166166
/**
167167
* @param {object} storage
168168
*
169-
* The lnurl-auth spec requires that a user's Lightning wallet trigger a
170-
* callback as part of the authentication flow. So, we require session storage to
169+
* pubkey auth flows require that a callback be triggered
170+
* part of the authentication flow. So, we require session storage to
171171
* persist some data and ensure it's available when the callback is triggered.
172172
* Data can be stored in a medium of your choice.
173173
*
@@ -269,7 +269,7 @@ const config: NextAuthPubkeyConfig = {
269269
/**
270270
* @param {string} nostrSignIn
271271
*
272-
* A Lightning auth page will be automatically generated unless the
272+
* A nostr auth page will be automatically generated unless the
273273
* `nostrSignIn` path is specified. It lets you define your own page where
274274
* you can configure a custom Next.js page and customize the UI.
275275
*
@@ -358,13 +358,13 @@ const config: NextAuthPubkeyConfig = {
358358
},
359359

360360
/**
361-
* Control the color scheme of the "Login with Lightning" page and button.
361+
* Control the color scheme of the "Login with ..." page and button.
362362
*/
363363
theme: {
364364
/**
365365
* @param {string} colorScheme
366366
*
367-
* Define a color scheme for the "Login with Lightning" UI.
367+
* Define a color scheme for the "Login with ..." UI.
368368
*
369369
* @default "light"
370370
*/
@@ -493,7 +493,7 @@ const config: NextAuthPubkeyConfig = {
493493

494494
# Storage
495495

496-
The `lnurl-auth` spec requires that a user's Lightning wallet trigger a callback as part of the authentication flow. For this reason, it may be that the device scanning the QR (e.g. a mobile) is not the same device that's trying to authenticate (e.g. a desktop). So, we require session storage to persist some data and make it available across devices and ensure it's available when the callback is triggered.
496+
pubkey auth flows require that a callback be triggered on success as part of the authentication flow. For this reason, it may be that the device scanning the QR (e.g. a mobile) is not the same device that's trying to authenticate (e.g. a desktop). So, we require session storage to persist some data and make it available across devices and ensure it's available when the callback is triggered.
497497

498498
Data can be stored in a medium of your choice. For example: a database, a document store, or a session store. Here's an example using [Vercel KV](https://vercel.com/docs/storage/vercel-kv):
499499

0 commit comments

Comments
 (0)