Skip to content

Commit 3fb2ca5

Browse files
committed
chore: synchronize workspaces
1 parent 284e051 commit 3fb2ca5

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

packages/nextjs/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,16 @@
11
# `@ory/nextjs`
22

3-
This package contains the Next.js SDK for Ory. It is additive to the
4-
`@ory/elements-react` package and provides utility functions for the app and
5-
page router.
3+
This package contains the Next.js SDK for Ory. It provides a set of React
4+
components, server-side components, and hooks to interact with the Ory
5+
ecosystem. Supports both app and page routers.
66

77
> [!NOTE]
88
> This package's primary use case is for developing custom components for login,
99
> registration, verification, settings, recovery, or consent. For integrating
1010
> authentication without changing the UI, follow our
1111
> [guide for Auth.js](https://www.ory.sh/docs/getting-started/integrate-auth/auth-js).
1212
13-
This middleware expects environment variable `NEXT_PUBLIC_ORY_SDK_URL` to be set
14-
to your Ory Network Project SDK URL. This is the URL that you would use to
15-
access the Ory API.
16-
17-
If you have a custom domain for your Ory Network Project, you should use the
18-
custom domain for `NEXT_PUBLIC_ORY_SDK_URL`.
19-
20-
## Installation
21-
22-
Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package.
23-
24-
## Examples
13+
## Use case
2514

2615
This package includes a middleware for the app and page router that enables
2716
local development and preview environments to work with
@@ -34,6 +23,17 @@ and
3423
[page router](https://github.com/ory/elements/blob/main/examples/nextjs-pages-router/middleware.ts)
3524
middleware example for more details.
3625

26+
## Installation
27+
28+
Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package.
29+
30+
## Configuration
31+
32+
This middleware expects environment variable `NEXT_PUBLIC_ORY_SDK_URL` to be set
33+
to your Ory Network Project SDK URL. This is the URL that you would use to
34+
access the Ory API. If you have a custom domain for your Ory Network Project,
35+
you should use the custom domain for `NEXT_PUBLIC_ORY_SDK_URL`.
36+
3737
## Learn by example
3838

3939
See the [examples](https://github.com/ory/elements/blob/main/examples) directory

0 commit comments

Comments
 (0)