Skip to content

Commit eb8cd3b

Browse files
committed
docs: add disclaimer
1 parent 1e654ad commit eb8cd3b

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

packages/next-auth/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
> [!WARNING]
2+
> This package is a Nuxt-focused fork of `next-auth` for use with `@sidebase/nuxt-auth`.
3+
> It is not intended to be a general Next.js drop-in replacement.
4+
>
5+
> Key differences from upstream `next-auth`:
6+
>
7+
> - The package is published as `@sidebase/fork-authjs` and is meant to be installed as a `next-auth` alias, for example `next-auth@npm:@sidebase/fork-authjs`.
8+
> - Removed Next.js and React entrypoints such as `next-auth/react`, `next-auth/next`, and `next-auth/middleware`.
9+
> - Provider imports should use the default export directly, for example `GithubProvider(...)`, not `GithubProvider.default(...)`.
10+
> - This fork targets Nuxt/Vite bundler usage through `@sidebase/nuxt-auth`; native Node ESM imports are not the primary compatibility target.
11+
> - Nodemailer support is limited to patched peer versions declared by this package.
12+
>
13+
> Install as a `next-auth` alias:
14+
>
15+
> ```sh
16+
> npm install next-auth@npm:@sidebase/fork-authjs
17+
> pnpm add next-auth@npm:@sidebase/fork-authjs
18+
> yarn add next-auth@npm:@sidebase/fork-authjs
19+
> ```
20+
121
<p align="center">
222
<br/>
323
<a href="https://next-auth.js.org" target="_blank"><img width="150px" src="https://next-auth.js.org/img/logo/logo-sm.png" /></a>

0 commit comments

Comments
 (0)