chore(remix): Add note about React Router v7 to README (#4783)

clerk · Dec 16, 2024 · 2d5c62b · 2d5c62b
1 parent cb36566
commit 2d5c62b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.changeset/large-hats-clap.md b/.changeset/large-hats-clap.md
@@ -0,0 +1,5 @@
+---
+'@clerk/remix': patch
+---
+
+Add note about React Router v7 to the README. If you want to use React Router v7 and Clerk together, please use the [`@clerk/react-router`](https://clerk.com/docs/references/react-router/overview) SDK instead.
diff --git a/packages/remix/README.md b/packages/remix/README.md
@@ -25,13 +25,15 @@
 
 </div>
 
+> [!IMPORTANT] If you're starting a new project with React Router v7 or are in the process of upgrading a Remix v2 application, please use the [`@clerk/react-router`](https://clerk.com/docs/references/react-router/overview) SDK. `@clerk/remix` is only compatible with Remix v2.
+
 ## Getting Started
 
 [Clerk](https://clerk.com/?utm_source=github&utm_medium=clerk_remix) is the easiest way to add authentication and user management to your Remix application. Add sign up, sign in, and profile management to your application in minutes.
 
 ### Prerequisites
 
-- Remix `^2.0.0` or later
+- Remix `^2.0.0`
 - React 18 or later
 - Node.js `>=18.17.0` or later
 - An existing Clerk application. [Create your account for free](https://dashboard.clerk.com/sign-up?utm_source=github&utm_medium=clerk_remix).