From 7becfa19859353f69c85ffce55a951305e87c7c3 Mon Sep 17 00:00:00 2001 From: Artur Sapek Date: Wed, 23 Oct 2024 13:41:54 -0400 Subject: [PATCH] add deprecation warning to the top of SDK readme (#4142) --- sdk/README.md | 3 ++- sdk/js/README.md | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/sdk/README.md b/sdk/README.md index 4424481358..18f5dd0600 100644 --- 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 index dcf1074de5..4d2846a7e0 100644 --- 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?