diff --git a/.changeset/neat-wasps-explain.md b/.changeset/neat-wasps-explain.md new file mode 100644 index 0000000000..639fe7cc17 --- /dev/null +++ b/.changeset/neat-wasps-explain.md @@ -0,0 +1,5 @@ +--- +"@clerk/clerk-sdk-node": patch +--- + +Add transition period notice and migration info diff --git a/README.md b/README.md index 0aeac9ce9c..a7389aeb60 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,11 @@ Would you like to work on Open Source software and help maintain this repository This repository contains the SDKs for environment/platforms that Clerk supports. For example, if you want to use Clerk with Node.js you can install: ```sh -npm install @clerk/clerk-sdk-node +npm install @clerk/backend # or -yarn add @clerk/clerk-sdk-node +yarn add @clerk/backend # or -pnpm add @clerk/clerk-sdk-node +pnpm add @clerk/backend ``` ## 🎓 Learning Clerk diff --git a/packages/sdk-node/README.md b/packages/sdk-node/README.md index e1fdedb1b9..95ac976fda 100644 --- a/packages/sdk-node/README.md +++ b/packages/sdk-node/README.md @@ -25,6 +25,9 @@ +> [!IMPORTANT] +> Starting October 8, 2024, the Node SDK is entering a three-month notice period. We encourage everyone to migrate to `@clerk/express`. For full details, please see our [changelog](https://clerk.com/changelog/2024-10-08-express-sdk). + ## Getting Started [Clerk](https://clerk.com/?utm_source=github&utm_medium=clerk_sdk_node) is the easiest way to add authentication and user management to your Node.js application. Add sign up, sign in, and profile management to your application in minutes. diff --git a/packages/sdk-node/src/index.ts b/packages/sdk-node/src/index.ts index 6de071dd83..4194c5e28e 100644 --- a/packages/sdk-node/src/index.ts +++ b/packages/sdk-node/src/index.ts @@ -24,3 +24,9 @@ export { createClerkExpressRequireAuth, createClerkExpressWithAuth }; export { requireAuth } from './requireAuth'; export { withAuth } from './withAuth'; + +console.warn( + 'Starting October 8, 2024, the Node SDK is entering a three-month notice period. ' + + 'We encourage everyone to migrate to @clerk/express. ' + + 'For full details, please see our changelog: https://clerk.com/changelog/2024-10-08-express-sdk', +);