Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add deprecation warning to the top of SDK readme #4142

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Add deprecation warning to the top of SDK readme #4142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 5 additions & 2 deletions sdk/js/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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?

Expand Down
Loading