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

Add deprecation note for xmtp-js SDK #743

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Add deprecation note for xmtp-js SDK #743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
284c95f
deprecate xmtp-js
jhaaaa Dec 4, 2024
c3f8de4
add alert style
jhaaaa Dec 4, 2024
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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ To learn more about the contents of this repository, see this README and the REA

### SDKs

- [`js-sdk`](https://github.com/xmtp/xmtp-js/blob/main/sdks/js-sdk): XMTP JS client SDK for Node and the browser
- [`node-sdk`](https://github.com/xmtp/xmtp-js/blob/main/sdks/node-sdk): XMTP client SDK for Node (V3 only)
- [`browser-sdk`](https://github.com/xmtp/xmtp-js/blob/main/sdks/browser-sdk): XMTP client SDK for browsers (V3 only)

Expand Down
14 changes: 8 additions & 6 deletions sdks/js-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# XMTP-JS

![Test](https://github.com/xmtp/xmtp-js/actions/workflows/test.yml/badge.svg)
![Lint](https://github.com/xmtp/xmtp-js/actions/workflows/lint.yml/badge.svg)
![Build](https://github.com/xmtp/xmtp-js/actions/workflows/build.yml/badge.svg)
![Status](https://img.shields.io/badge/Project_Status-Production-brightgreen)
![Status](https://img.shields.io/badge/Deprecated-brown)

![x-red-sm](https://user-images.githubusercontent.com/510695/163488403-1fb37e86-c673-4b48-954e-8460ae4d4b05.png)
> [!CAUTION]
> The XMTP-JS SDK is no longer maintained.

**XMTP client SDK for JavaScript applications**
For your project, consider using the [Browser SDK](/sdks/browser-sdk/README.md) or [Node SDK](/sdks/node-sdk/README.md). These updated SDKs provide enhanced functionality and are designed to provide better support for your development needs.

The documentation below is provided for reference only.

## XMTP client SDK for JavaScript applications

`xmtp-js` provides a TypeScript implementation of an XMTP client for use with JavaScript and React applications.

Expand Down
Loading