Add Deprecation Notice

skip-mev · Jul 9, 2024 · ac0eb81 · ac0eb81
2 parents 841e650 + 14c3372
commit ac0eb81
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/.changeset/early-buses-collect.md b/.changeset/early-buses-collect.md
@@ -0,0 +1,5 @@
+---
+"@skip-router/core": patch
+---
+
+Deprecation notice, please use @skip-go/core moving forward
diff --git a/README.md b/README.md
@@ -1,4 +1,15 @@
-![header](https://files.readme.io/4f92aa7-DALLE_Cover_Photo_1..png)
+## Deprecation Notice
+
+**⚠️ This project is deprecated**
+
+This repository is no longer actively maintained and may not receive future updates or bug fixes. Please use the now maintained and developed [@skip-go/core](https://www.npmjs.com/package/@skip-router/core) as a replacement.
+
+### Migration Guide
+@skip-router/core@5.2.0 is the same as @skip-go/core@0.2.0. To migrate packages with minimal disruption, please upgrade to @skip-router/core@5.2.0 and then replace the package with @skip-go/core@0.2.0, then upgrading to the latest version from there.
+
+Thank you for your understanding and for using our software.
+
+For any questions, please reach out to us in our [discord](https://skip.build/discord) if you have any questions and/or need assistance migrating!
 
 # Skip Router SDK
 

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,3 +1,16 @@
+## Deprecation Notice
+
+**⚠️ This project is deprecated**
+
+This repository is no longer actively maintained and may not receive future updates or bug fixes. Please use the now maintained and developed [@skip-go/core](https://www.npmjs.com/package/@skip-router/core) as a replacement.
+
+### Migration Guide
+@skip-router/core@5.2.0 is the same as @skip-go/core@0.2.0. To migrate packages with minimal disruption, please upgrade to @skip-router/core@5.2.0 and then replace the package with @skip-go/core@0.2.0, then upgrading to the latest version from there.
+
+Thank you for your understanding and for using our software.
+
+For any questions, please reach out to us in our [discord](https://skip.build/discord) if you have any questions and/or need assistance migrating!
+
 ![header](https://files.readme.io/4f92aa7-DALLE_Cover_Photo_1..png)
 
 [![npm/v](https://badgen.net/npm/v/@skip-router/core)](https://www.npmjs.com/package/@skip-router/core)