certusone
/
wormhole
mirror of https://github.com/certusone/wormhole.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

This commit is contained in:
Artur Sapek 2024-10-23 13:41:54 -04:00 committed by GitHub
parent abd0b330ef
commit 7becfa1985
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
sdk/README.md
View File

@ -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.

7
sdk/js/README.md
View File

@ -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?