chore: synchronize workspaces

ory · Jan 9, 2025 · 561e7ad · 561e7ad
1 parent 75989f9
commit 561e7ad
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 11 deletions.
diff --git a/examples/nextjs-spa/README.md b/examples/nextjs-spa/README.md
@@ -1,7 +1,7 @@
 # Ory Elements
 
-> [!CAUTION] This example uses an outdated version of Ory Elements. Please
-> use example [`nextjs-spa`](../nextjs-spa/README.md) instead.
+> [!CAUTION] This example uses an outdated version of Ory Elements. Please use
+> example [`nextjs-spa`](../nextjs-spa/README.md) instead.
 
 Ory Elements is a component library that makes building login, registration and
 account pages for Ory a breeze.

diff --git a/examples/preact-spa/README.md b/examples/preact-spa/README.md
@@ -1,7 +1,7 @@
 # Ory Elements
 
-> [!CAUTION] This example uses an outdated version of Ory Elements. Please
-> use example [`nextjs-spa`](../nextjs-spa/README.md) instead.
+> [!CAUTION] This example uses an outdated version of Ory Elements. Please use
+> example [`nextjs-spa`](../nextjs-spa/README.md) instead.
 
 Ory Elements is a component library that makes building login, registration and
 account pages for Ory a breeze.

diff --git a/examples/react-spa/README.md b/examples/react-spa/README.md
@@ -1,7 +1,7 @@
 # Ory Elements
 
-> [!CAUTION] This example uses an outdated version of Ory Elements. Please
-> use example [`nextjs-spa`](../nextjs-spa/README.md) instead.
+> [!CAUTION] This example uses an outdated version of Ory Elements. Please use
+> example [`nextjs-spa`](../nextjs-spa/README.md) instead.
 
 Ory Elements is a component library that makes building login, registration and
 account pages for Ory a breeze.

diff --git a/packages/nextjs/README.md b/packages/nextjs/README.md
@@ -1,17 +1,34 @@
-# nextjs
+# `@ory/nextjs`
 
-This library was generated with [Nx](https://nx.dev).
+This package contains the Next.js SDK for Ory. It provides a set of React
+components, server-side components, and hooks to interact with the Ory
+ecosystem.
 
-## Building
+Supports both app and page routers.
+
+## Installation
+
+Run `npm install @ory/nextjs` or `yarn add @ory/nextjs` to install the package.
+
+## Examples
+
+See the [examples](../../examples) directory for examples on how to use the
+package.
+
+## Development
+
+This package is built using Nx.
+
+### Building
 
 Run `nx build @ory/nextjs` to build the library.
 
-## Developing
+### Developing
 
 Run `nx dev @ory/nextjs` to watch the source code for changes and continuously
 build the library.
 
-## Running unit tests
+### Running unit tests
 
 Run `nx test @ory/nextjs` to execute the unit tests via
 [Jest](https://jestjs.io).