chore(@stylexswc/nextjs-swc-plugin): marked as deprecated

Dwlad90 · Dec 9, 2024 · c7b22c1 · c7b22c1
1 parent fe87458
commit c7b22c1
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/packages/nextjs-swc-plugin/README.md b/packages/nextjs-swc-plugin/README.md
@@ -1,7 +1,25 @@
 # SWC Stylex plugin for Next.js
 
-> [!WARNING]
-> **Deprecated**: This package is deprecated as of version `0.3.0` and may be removed in the future. Please use the [`nextjs-plugin`](https://github.com/dwlad90/stylex-swc-plugin/tree/develop/packages/nextjs-plugin) instead.
+> [!CAUTION]
+> **DEPRECATED**: This package is deprecated as of version 0.5.0. Please migrate to [`@stylexswc/nextjs-plugin`](https://github.com/dwlad90/stylex-swc-plugin/tree/develop/packages/nextjs-plugin) which is the official replacement.
+
+## Migration Guide
+
+To migrate from this package to the new one:
+
+1. Uninstall this package:
+
+```sh
+npm uninstall @stylexswc/nextjs-swc-plugin
+```
+
+2. Install the new package:
+
+```sh
+npm install --save-dev @stylexswc/nextjs-plugin
+```
+
+3. Update `next.config.js` according to the [Advanced Options](https://github.com/Dwlad90/stylex-swc-plugin/tree/develop/packages/nextjs-swc-plugin#plugin-options) section.
 
 ## Breaking Changes in v0.5.0
 

diff --git a/packages/nextjs-swc-plugin/package.json b/packages/nextjs-swc-plugin/package.json
@@ -10,6 +10,7 @@
   "dependencies": {
     "@stylexjs/babel-plugin": "^0.9.3"
   },
+  "deprecated": "Package deprecated since v0.5.0. Please use @stylexswc/nextjs-plugin instead. This package will be removed in the next minor release.",
   "devDependencies": {
     "@babel/types": "^7.23.9",
     "@stylexswc/eslint-config": "0.4.4",