docs: update readme's and vulnerable dependencies (#270)

ory · Jan 9, 2025 · 2b7e845 · 2b7e845
1 parent 3eea284
commit 2b7e845
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -3,28 +3,29 @@
 # Ory Elements
 
 Ory Elements is a component library that makes building login, registration and
-account pages for Ory a breeze.
+account pages for Ory a breeze:
 
 - Reduces time to add complex auth flows to your customer experience, including
-  multi-factor authentication and account recovery
-- Themeable and modular - use only what you need from it
-- Works with the React ecosystem (NextJS, React SPA, Preact SPA)
-- Works with the Express based ecosystem
+  multi-factor authentication and account recovery.
+- Customizable, themeable, and replaceable components.
+- Works with the React ecosystem (NextJS, React SPA).
 - Dynamically adapts the user interface to your Ory identity schema, sign-in and
-  flow configuration
+  flow configuration.
 
-Ory Elements supports integrating with:
+Ory Elements' comes with several packages:
 
-- React
-- Preact
-- Express.js (experimental)
+- [`@ory/elements-react`](./packages/elements-react/README.md)
+- [`@ory/nextjs`](./packages/nextjs/README.md)
 
-Ory Elements stands apart from the SDK and your application data layer. This is
-intentional so that you still have control over how you would like to interact
-with Ory in your application. How you manage your application state is all up to
-you. Below is a simple diagram of how Ory Elements fits into your application.
+Additionally, the v0 version of Ory Elements is in maintenance mode for
+packages:
 
-![Ory Elements](./.assets/ory-stack.png)
+- [`@ory/elements-markup`](./packages/markup/README.md)
+- [`@ory/elements-preact`](./packages/preact/README.md)
+- [`@ory/elements-markup`](./packages/markup/README.md)
+
+If you use one of the above packages, we recommend migrating to the new packages
+ASAP.
 
 ## Getting Started
 

diff --git a/examples/nextjs-spa/README.md b/examples/nextjs-spa/README.md
@@ -1,5 +1,8 @@
 # Ory Elements
 
+> [!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,5 +1,8 @@
 # Ory Elements
 
+> [!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,5 +1,8 @@
 # Ory Elements
 
+> [!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/markup/README.md b/packages/markup/README.md
@@ -1,5 +1,9 @@
 # Ory Elements
 
+> [!CAUTION] This package is in maintenance mode and is no longer actively
+> developed. Please use [`@ory/elements-react`](../elements-react/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).
diff --git a/packages/preact/README.md b/packages/preact/README.md
@@ -1,5 +1,9 @@
 # Ory Elements
 
+> [!CAUTION] This package is in maintenance mode and is no longer actively
+> developed. Please use [`@ory/elements-react`](../elements-react/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/react/README.md b/packages/react/README.md
@@ -1,5 +1,9 @@
 # Ory Elements
 
+> [!CAUTION] This package is in maintenance mode and is no longer actively
+> developed. Please use [`@ory/elements-react`](../elements-react/README.md)
+> instead.
+
 Ory Elements is a component library that makes building login, registration and
 account pages for Ory a breeze.