Skip to content

Commit

Permalink
Add deprecation note for xmtp-js SDK (#743)
Browse files Browse the repository at this point in the history
* deprecate xmtp-js

* add alert style
  • Loading branch information
jhaaaa authored Dec 4, 2024
1 parent eb762b0 commit 299d24d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
1 change: 0 additions & 1 deletion README.md
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
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

0 comments on commit 299d24d

Please sign in to comment.