From 284c95fd50f86af11ceb234ee402632578c9fbf2 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa <5481259+jhaaaa@users.noreply.github.com> Date: Tue, 3 Dec 2024 16:00:03 -0800 Subject: [PATCH 1/2] deprecate xmtp-js --- README.md | 1 - sdks/js-sdk/README.md | 11 ++++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 469a85cd7..70b2eae17 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/sdks/js-sdk/README.md b/sdks/js-sdk/README.md index d712de8ba..f6ca63f7b 100644 --- a/sdks/js-sdk/README.md +++ b/sdks/js-sdk/README.md @@ -1,11 +1,12 @@ # 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) +**The XMTP-JS SDK is no longer maintained.** + +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** From c3f8de4ee2ea7c0dbabadf287ed61cfad27c2e40 Mon Sep 17 00:00:00 2001 From: Jennifer Hasegawa <5481259+jhaaaa@users.noreply.github.com> Date: Tue, 3 Dec 2024 16:55:43 -0800 Subject: [PATCH 2/2] add alert style --- sdks/js-sdk/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/sdks/js-sdk/README.md b/sdks/js-sdk/README.md index f6ca63f7b..8a61bd021 100644 --- a/sdks/js-sdk/README.md +++ b/sdks/js-sdk/README.md @@ -2,13 +2,14 @@ ![Status](https://img.shields.io/badge/Deprecated-brown) -**The XMTP-JS SDK is no longer maintained.** +> [!CAUTION] +> The XMTP-JS SDK is no longer maintained. 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 client SDK for JavaScript applications `xmtp-js` provides a TypeScript implementation of an XMTP client for use with JavaScript and React applications.