Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme's and vulnerable dependencies #270

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions examples/nextjs-spa/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 3 additions & 0 deletions examples/preact-spa/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 3 additions & 0 deletions examples/react-spa/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Loading
Loading