add deprecation warning to the top of SDK readme (#4142)

wormhole-foundation · Oct 23, 2024 · 7becfa1 · 7becfa1
1 parent abd0b33
commit 7becfa1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/sdk/README.md b/sdk/README.md
@@ -8,7 +8,8 @@ wormhole.
  * [sdk/](./): Go SDK.  This package must live in this directory so that clients can use the
    `github.com/wormhole-foundation/wormhole/sdk` import path.
  * [vaa/](./vaa/): Go package for using VAAs (Verifiable Action Approval).
- * [js/](./js/README.md): Javascript SDK.
+ * [js/](./js/README.md): Legacy JavaScript SDK (**Deprecated and Unsupported**)
+   * Please use the new Wormhole TypeScript SDK instead: [`@wormhole-foundation/sdk`](https://github.com/wormhole-foundation/wormhole-sdk-ts)
  * [js-proto-node/](./js-proto-node/README.md): NodeJS client protobuf.
  * [js-proto-web/](./js-proto-web/README.md): Web client protobuf.
  * [js-wasm/](./js-wasm/README.md): WebAssembly libraries.

diff --git a/sdk/js/README.md b/sdk/js/README.md
@@ -1,6 +1,9 @@
-# Wormhole SDK
+# Wormhole Legacy SDK (Deprecated)
 
-> Note: This is a pre-alpha release and in active development. Function names and signatures are subject to change.
+> [!CAUTION]
+> **This SDK is Deprecated and Unsupported**
+>
+> Please use the new Wormhole TypeScript SDK instead: [`@wormhole-foundation/sdk`](https://github.com/wormhole-foundation/wormhole-sdk-ts)
 
 ## What is Wormhole?