diff --git a/README.md b/README.md index 26889bac..9cd473f8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,35 @@ -# Nylas Components +> [!CAUTION] +> πŸ›‘ **Nylas Components are built for the Nylas v2 API and are no longer actively developed.** +> +> They are **not supported on the v3 API** and will not be updated to it. For new v3 projects, use the [Scheduler UI components](https://developer.nylas.com/docs/v3/scheduler/) and the current [SDKs](https://developer.nylas.com/docs/v3/sdks/). The v2 usage below remains for existing integrations. + +
+ + Nylas + + +

Nylas Components

+ +

+ UI building blocks for email, calendar, and contacts β€” from Nylas, the infrastructure that powers communications +

+ +

+ πŸ“– Docs Β· + πŸ“š API Reference Β· + πŸš€ Sign up Β· + πŸ’‘ Samples Β· + πŸ’¬ Forum +

+ +

Status: Deprecated (v2 only)

+
+ +
Nylas Components are a suite of UI building blocks that let you build user-facing email, calendar, and contacts functionality in minutes. Use Nylas Components with your Nylas account or by adding standard JSON data. -## Compatibility -- [Nylas API v2](https://developer.nylas.com/docs/api/v2/) -- [Nylas API v3](https://developer.nylas.com/docs/api/v3) (Unsupported) +[Nylas](https://developer.nylas.com/) is the infrastructure that powers communications β€” integrate with Gmail, Microsoft, IMAP, Zoom, and 250+ providers in 5 minutes, or give your AI agent its own mailbox. The broader platform covers [Agent Accounts](https://developer.nylas.com/docs/v3/agent-accounts/), [Email](https://developer.nylas.com/docs/v3/email/), [Calendar](https://developer.nylas.com/docs/v3/calendar/), [Contacts](https://developer.nylas.com/docs/v3/email/contacts/), [Scheduler](https://developer.nylas.com/docs/v3/scheduler/), and [Notetaker](https://developer.nylas.com/docs/v3/notetaker/). ## Background @@ -19,7 +44,7 @@ The Nylas Components include: - [Contact List](./components/contact-list): Display a list of selectable contacts from a user’s contacts book. - [Composer](./components/composer): Draft and send emails. -The Components repository is for people who want to modify the code and build it from the source. Visit our [documentation](https://developer.nylas.com/docs/user-experience/components/) if you are looking for the easiest way to get started with Nylas Components. +The Components repository is for people who want to modify the code and build it from the source. Visit our [documentation](https://developer.nylas.com/) if you are looking for the easiest way to get started with Nylas Components. If you want to report a bug, create a feature request, or contribute code, take a look at the [Contributing Guidelines](CONTRIBUTING.md). @@ -55,9 +80,9 @@ You can use `` ## Usage -Each Component can be used with a Nylas account or by passing in a JSON object. To get a component ID, create a [Nylas account](https://dashboard.nylas.com/register), then click Components. From there you'll be able to create a new component and get an ID. +Each Component can be used with a Nylas account or by passing in a JSON object. To get a component ID, create a [Nylas account](https://dashboard-v3.nylas.com/register), then click Components. From there you'll be able to create a new component and get an ID. -To see an example of each, check out the [documentation](https://developer.nylas.com/docs/user-experience/components/). +To see an example of each, check out the [documentation](https://developer.nylas.com/). ### Agenda Nylas Account