Skip to content

Commit a6b3364

Browse files
committed
docs: update framework READMEs
1 parent c860025 commit a6b3364

File tree

6 files changed

+88
-176
lines changed

6 files changed

+88
-176
lines changed

README.md

Lines changed: 30 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,12 @@
55
<p align="center">Authentication for the Web.</p>
66
<p align="center">Open Source. Full Stack. Own Your Data.</p>
77
<p align="center" style="align: center;">
8-
<a href="https://npm.im/@auth/core">
9-
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
10-
</a>
11-
<a href="https://www.npmtrends.com/next-auth">
12-
<img src="https://img.shields.io/npm/dm/next-auth?style=flat-square" alt="Downloads" />
13-
</a>
14-
<a href="https://github.com/nextauthjs/next-auth/stargazers">
15-
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
16-
</a>
17-
<a href="https://www.npmjs.com/package/next-auth">
18-
<img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?label=latest&style=flat-square" alt="GitHub Stable Release" />
19-
</a>
20-
<a href="https://codecov.io/gh/nextauthjs/next-auth" >
21-
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/nextauthjs/next-auth?token=o2KN5GrPsY&style=flat-square&logo=codecov">
22-
</a>
8+
<a href="https://github.com/nextauthjs/next-auth/releases"><img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?style=flat-square&label=latest%20release&color=purple" alt="GitHub Stable Release" /></a>
9+
<!-- TODO: Should count `@auth/core` when NextAuth.js v5 is released as stable. -->
10+
<a href="https://www.npmtrends.com/next-auth"><img src="https://img.shields.io/npm/dm/next-auth?style=flat-square&color=cyan" alt="Downloads" /></a>
11+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
12+
<a href="https://codecov.io/gh/nextauthjs/next-auth" ><img alt="Codecov" src="https://img.shields.io/codecov/c/github/nextauthjs/next-auth?token=o2KN5GrPsY&style=flat-square&logo=codecov"></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
2314
</p>
2415
<p align="center">
2516
Auth.js is a set of open-source packages that are built on standard Web APIs for authentication in modern applications with any framework on any platform in any JS runtime.
@@ -43,15 +34,16 @@
4334
- Designed to work with any OAuth service, it supports 2.0+, OIDC
4435
- Built-in support for [many popular sign-in services](https://github.com/nextauthjs/next-auth/tree/main/packages/core/src/providers)
4536
- Email/Passwordless authentication
37+
- Passkeys/WebAuthn support
4638
- Bring Your Database - or none! - stateless authentication with any backend (Active Directory, LDAP, etc.)
47-
- Runtime-agnostic, runs anywhere! (Vercel Edge Functions, Node.js, Serverless, etc.)
39+
- Runtime-agnostic, runs anywhere! (Docker, Node.js, Serverless, etc.)
4840

4941
### Own your data
5042

5143
Auth.js can be used with or without a database.
5244

5345
- An open-source solution that allows you to keep control of your data
54-
- Built-in support for [MySQL, MariaDB, Postgres, Microsoft SQL Server, MongoDB, SQLite, etc.](https://adapters.authjs.dev)
46+
- Built-in support for [MySQL, MariaDB, Postgres, Microsoft SQL Server, MongoDB, SQLite, GraphQL, etc.](https://adapters.authjs.dev)
5547
- Works great with databases from popular hosting providers
5648

5749
### Secure by default
@@ -95,97 +87,97 @@ We have an [OpenCollective](https://opencollective.com/nextauth) for companies a
9587
<tr>
9688
<td align="center" valign="top">
9789
<a href="https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=authjs&utm_content=sponsor" target="_blank">
98-
<img width="108" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
90+
<img height="96" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
9991
</a><br />
10092
<div>Clerk</div>
10193
<sub>💵</sub>
10294
</td>
10395
<td align="center" valign="top">
10496
<a href="https://fusionauth.io" target="_blank">
105-
<img width="108" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
97+
<img height="96" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
10698
</a><br />
10799
<div>FusionAuth</div>
108100
<sub>💵</sub>
109101
</td>
110102
<td align="center" valign="top">
111103
<a href="https://www.beyondidentity.com" target="_blank">
112-
<img width="108" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
104+
<img height="96" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
113105
</a><br />
114106
<div>Beyond Identity</div>
115107
<sub>💵</sub>
116108
</td>
117109
<td align="center" valign="top">
118110
<a href="https://stytch.com" target="_blank">
119-
<img width="108" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
111+
<img height="96" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
120112
</a><br />
121113
<div>Stytch</div>
122114
<sub>💵</sub>
123115
</td>
124116
<td align="center" valign="top">
125117
<a href="https://prisma.io" target="_blank">
126-
<img width="108" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
118+
<img height="96" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
127119
</a><br />
128120
<div>Prisma</div>
129121
<sub>💵</sub>
130122
</td>
131123
<td align="center" valign="top">
132124
<a href="https://lowdefy.com" target="_blank">
133-
<img width="108" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
125+
<img height="96" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
134126
</a><br />
135127
<div>Lowdefy</div>
136128
<sub>💵</sub>
137129
</td>
138-
<td align="center" valign="top">
139-
<a href="https://vercel.com" target="_blank">
140-
<img width="108" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
141-
</a><br />
142-
<div>Vercel</div>
143-
<sub>💵☁️</sub>
144-
</td>
145-
</tr>
146-
<tr>
147130
<td align="center" valign="top">
148131
<a href="https://www.descope.com" target="_blank">
149-
<img width="108" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
132+
<img height="96" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
150133
</a><br />
151134
<div>Descope</div>
152135
<sub>💵</sub>
153136
</td>
137+
</tr>
138+
<tr>
154139
<td align="center" valign="top">
155140
<a href="https://badass.dev" target="_blank">
156-
<img width="108" src="https://avatars.githubusercontent.com/u/136839242?v=4" alt="Badass Courses Logo" />
141+
<img height="96" src="https://avatars.githubusercontent.com/u/136839242?v=4" alt="Badass Courses Logo" />
157142
</a><br />
158143
<div>Badass Courses</div>
159144
<sub>💵</sub>
160145
</td>
161146
<td align="center" valign="top">
162147
<a href="https://github.com/encoredev/encore" target="_blank">
163-
<img width="108" src="https://avatars.githubusercontent.com/u/50438175?v=4" alt="Encore Logo" />
148+
<img height="96" src="https://avatars.githubusercontent.com/u/50438175?v=4" alt="Encore Logo" />
164149
</a><br />
165150
<div>Encore</div>
166151
<sub>💵</sub>
167152
</td>
168153
<td align="center" valign="top">
169154
<a href="https://checklyhq.com" target="_blank">
170-
<img width="108" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
155+
<img height="96" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
171156
</a><br />
172157
<div>Checkly</div>
173158
<sub>☁️</sub>
174159
</td>
175160
<td align="center" valign="top">
176161
<a href="https://superblog.ai/" target="_blank">
177-
<img width="108" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
162+
<img height="96" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
178163
</a><br />
179164
<div>superblog</div>
180165
<sub>☁️</sub>
181166
</td>
182167
<td align="center" valign="top">
183168
<a href="https://www.netlight.com/" target="_blank">
184-
<img width="108" src="https://avatars.githubusercontent.com/u/1672348?s=200&v=4" alt="Netlight logo" />
169+
<img height="96" src="https://avatars.githubusercontent.com/u/1672348?s=200&v=4" alt="Netlight logo" />
185170
</a><br />
186171
<div>Netlight</div>
187172
<sub>☁️</sub>
188173
</td>
174+
<td align="center" valign="top">
175+
<a href="https://vercel.com" target="_blank">
176+
<img height="96" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
177+
</a><br />
178+
<div>Vercel</div>
179+
<sub>☁️</sub>
180+
</td>
189181
</tr>
190182
</tbody>
191183
</table>

packages/frameworks-express/README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
<p align="center">
2-
<br/>
3-
<a href="https://authjs.dev" target="_blank"><img width="150px" src="https://authjs.dev/img/logo-sm.png" /></a>
4-
<h3 align="center">Express Auth</a></h3>
5-
<h4 align="center">Authentication for Express.</h4>
6-
<p align="center" style="align: center;">
7-
<a href="https://npm.im/next-auth">
8-
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
9-
</a>
10-
<a href="https://npm.im/@auth/express">
11-
<img alt="npm" src="https://img.shields.io/npm/v/@auth/express?color=green&label=@auth/express&style=flat-square">
12-
</a>
13-
<a href="https://www.npmtrends.com/@auth/express">
14-
<img src="https://img.shields.io/npm/dm/@auth/express?label=%20downloads&style=flat-square" alt="Downloads" />
15-
</a>
16-
<a href="https://github.com/nextauthjs/next-auth/stargazers">
17-
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
18-
</a>
19-
</p>
2+
<a href="https://expressjs.com" target="_blank"><img height="96px" src="https://authjs.dev/img/etc/express.svg" /></a>
3+
<a href="https://express.authjs.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
4+
<h1 align="center">Express Auth</h1>
5+
</p>
6+
<p align="center">
7+
Authentication for Express.
8+
</p>
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/@auth/express"><img src="https://img.shields.io/npm/v/@auth/express?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
11+
<a href="https://www.npmtrends.com/@auth/express"><img src="https://img.shields.io/npm/dm/@auth/express?style=flat-square&color=cyan" alt="Downloads" /></a>
12+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
2014
</p>
2115

2216
---

packages/frameworks-qwik/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<p align="center">
22
<a href="https://qwik.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/etc/qwik.svg" /></a>
33
<a href="https://qwik.authjs.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
4-
<h1 align="center">Qwik Auth.js</h1>
4+
<h1 align="center">Qwik Auth</h1>
55
</p>
66
<p align="center">
77
Authentication for Qwik.
88
</p>
99
<p align="center">
10-
<a href="https://npm.im/@auth/qwik"><img src="https://img.shields.io/badge/TypeScript-grey?style=flat-square&logo=typescript&labelColor=fff" alt="TypeScript" /></a>
11-
<a href="https://www.npmtrends.com/@auth/qwik"><img src="https://img.shields.io/npm/dm/@auth/qwik?style=flat-square&color=cyan" alt="Downloads" /></a>
1210
<a href="https://www.npmjs.com/package/@auth/qwik"><img src="https://img.shields.io/npm/v/@auth/qwik?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
13-
<a href="https://github.com/nextauthjs/cli/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
11+
<a href="https://www.npmtrends.com/@auth/qwik"><img src="https://img.shields.io/npm/dm/@auth/qwik?style=flat-square&color=cyan" alt="Downloads" /></a>
12+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
1414
</p>
1515

1616
---
Lines changed: 18 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,18 @@
1-
# Getting started
2-
3-
Recommended to use [create-jd-app](https://github.com/OrJDev/create-jd-app)
4-
5-
```bash
6-
npm install @auth/solid-start@latest @auth/core@latest
7-
```
8-
9-
## Setting It Up
10-
11-
[Generate auth secret](https://generate-secret.vercel.app/32), then set it as an environment variable:
12-
13-
```
14-
AUTH_SECRET=your_auth_secret
15-
```
16-
17-
### On Production
18-
19-
Don't forget to trust the host.
20-
21-
```
22-
AUTH_TRUST_HOST=true
23-
```
24-
25-
## Creating the api handler
26-
27-
in this example we are using github so make sure to set the following environment variables:
28-
29-
```
30-
GITHUB_ID=your_github_oauth_id
31-
GITHUB_SECRET=your_github_oauth_secret
32-
```
33-
34-
```ts
35-
// routes/api/auth/[...solidauth].ts
36-
import { SolidAuth, type SolidAuthConfig } from "@auth/solid-start"
37-
import GitHub from "@auth/core/providers/github"
38-
39-
export const authOpts: SolidAuthConfig = {
40-
providers: [
41-
GitHub({
42-
clientId: process.env.GITHUB_ID,
43-
clientSecret: process.env.GITHUB_SECRET,
44-
}),
45-
],
46-
debug: false,
47-
}
48-
49-
export const { GET, POST } = SolidAuth(authOpts)
50-
```
51-
52-
## Signing in and out
53-
54-
```ts
55-
import { signIn, signOut } from "@auth/solid-start/client"
56-
const login = () => signIn("github")
57-
const logout = () => signOut()
58-
```
59-
60-
## Getting the current session
61-
62-
```ts
63-
import { getSession } from "@auth/solid-start"
64-
import { createServerData$ } from "solid-start/server"
65-
import { authOpts } from "~/routes/api/auth/[...solidauth]"
66-
67-
export const useSession = () => {
68-
return createServerData$(
69-
async (_, { request }) => {
70-
return await getSession(request, authOpts)
71-
},
72-
{ key: () => ["auth_user"] }
73-
)
74-
}
75-
76-
// useSession returns a resource:
77-
const session = useSession()
78-
const loading = session.loading
79-
const user = () => session()?.user
80-
```
1+
<p align="center">
2+
<a href="https://start.solidjs.com" target="_blank"><img height="96px" src="https://authjs.dev/img/etc/solidstart.svg" /></a>
3+
<a href="https://solid-start.authjs.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
4+
<h1 align="center">SolidStart Auth</h1>
5+
</p>
6+
<p align="center">
7+
Authentication for SolidStart.
8+
</p>
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/@auth/solid-start"><img src="https://img.shields.io/npm/v/@auth/solid-start?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
11+
<a href="https://www.npmtrends.com/@auth/solid-start"><img src="https://img.shields.io/npm/dm/@auth/solid-start?style=flat-square&color=cyan" alt="Downloads" /></a>
12+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
14+
</p>
15+
16+
---
17+
18+
Check out the documentation at [solid-start.authjs.dev](https://solid-start.authjs.dev).

packages/frameworks-sveltekit/README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
<p align="center">
2-
<br/>
3-
<a href="https://authjs.dev" target="_blank"><img width="150px" src="https://authjs.dev/img/logo-sm.png" /></a>
4-
<h3 align="center">SvelteKit Auth</a></h3>
5-
<h4 align="center">Authentication for SvelteKit.</h4>
6-
<p align="center" style="align: center;">
7-
<a href="https://npm.im/next-auth">
8-
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
9-
</a>
10-
<a href="https://npm.im/@auth/sveltekit">
11-
<img alt="npm" src="https://img.shields.io/npm/v/@auth/sveltekit?color=green&label=@auth/sveltekit&style=flat-square">
12-
</a>
13-
<a href="https://www.npmtrends.com/@auth/sveltekit">
14-
<img src="https://img.shields.io/npm/dm/@auth/sveltekit?label=%20downloads&style=flat-square" alt="Downloads" />
15-
</a>
16-
<a href="https://github.com/nextauthjs/next-auth/stargazers">
17-
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
18-
</a>
19-
</p>
2+
<a href="https://kit.svelte.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/etc/sveltekit.svg" /></a>
3+
<a href="https://sveltekit.authjs.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
4+
<h1 align="center">SvelteKit Auth</h1>
5+
</p>
6+
<p align="center">
7+
Authentication for SvelteKit.
8+
</p>
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/@auth/sveltekit"><img src="https://img.shields.io/npm/v/@auth/sveltekit?style=flat-square&label=latest&color=purple" alt="npm latest release" /></a>
11+
<a href="https://www.npmtrends.com/@auth/sveltekit"><img src="https://img.shields.io/npm/dm/@auth/sveltekit?style=flat-square&color=cyan" alt="Downloads" /></a>
12+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
2014
</p>
2115

2216
---

packages/next-auth/README.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,16 @@
11
<p align="center">
2-
<br/>
3-
<a href="https://authjs.dev" target="_blank"><img width="150px" src="https://authjs.dev/img/logo-sm.png" /></a>
4-
<h3 align="center">NextAuth.js</a></h3>
5-
<h4 align="center">Authentication for Next.js.</h4>
6-
<p align="center" style="align: center;">
7-
<a href="https://npm.im/next-auth">
8-
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
9-
</a>
10-
<a href="https://npm.im/next-auth">
11-
<img alt="npm" src="https://img.shields.io/npm/v/next-auth?color=green&label=next-auth&style=flat-square">
12-
</a>
13-
<a href="https://www.npmtrends.com/next-auth">
14-
<img src="https://img.shields.io/npm/dm/next-auth?label=%20downloads&style=flat-square" alt="Downloads" />
15-
</a>
16-
<a href="https://github.com/nextauthjs/next-auth/stargazers">
17-
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square" alt="GitHub Stars" />
18-
</a>
19-
</p>
2+
<a href="https://nextjs.org" target="_blank"><img height="96px" src="https://authjs.dev/img/etc/nextjs.svg" /></a>
3+
<a href="https://nextjs.authjs.dev" target="_blank"><img height="96px" src="https://authjs.dev/img/logo-sm.png" /></a>
4+
<h1 align="center">NextAuth.js</h1>
5+
</p>
6+
<p align="center">
7+
Authentication for Next.js.
8+
</p>
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/next-auth"><img src="https://img.shields.io/npm/v/next-auth/beta?style=flat-square&label=latest&color=purple" alt="npm beta release" /></a>
11+
<a href="https://www.npmtrends.com/next-auth"><img src="https://img.shields.io/npm/dm/next-auth?style=flat-square&color=cyan" alt="Downloads" /></a>
12+
<a href="https://github.com/nextauthjs/next-auth/stargazers"><img src="https://img.shields.io/github/stars/nextauthjs/next-auth?style=flat-square&color=orange" alt="Github Stars" /></a>
13+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=fff&style=flat-square" alt="TypeScript" />
2014
</p>
2115

2216
---

0 commit comments

Comments
 (0)