Skip to content

Commit

Permalink
Merge pull request #297 from xmtp/dep-react-cs
Browse files Browse the repository at this point in the history
Add deprecation notes for React SDK and consent proof sigs
  • Loading branch information
jhaaaa authored Jan 14, 2025
2 parents 5a8bd3c + 21543e6 commit b87015c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
10 changes: 7 additions & 3 deletions packages/consent-proof-signature/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
> [!NOTE]
> This package has been removed from this repository. Its contents and all active development have been moved to the [xmtp-js](https://github.com/xmtp/xmtp-js) repository.
# Consent Proof Signature

![Status](https://img.shields.io/badge/Deprecated-brown)

> [!CAUTION]
> The Consent Proof Signature package is no longer maintained.
The documentation below is provided for reference only.

## Usage

```ts
Expand Down
13 changes: 10 additions & 3 deletions packages/react-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# React XMTP client SDK

![Status](https://img.shields.io/badge/Project_Status-Production-brightgreen)
![Status](https://img.shields.io/badge/Deprecated-brown)

> [!CAUTION]
> The React XMTP client SDK is no longer maintained.
For your project, consider using the [Browser SDK](https://github.com/xmtp/xmtp-js/tree/main/sdks/browser-sdk) or [Node SDK](https://github.com/xmtp/xmtp-js/tree/main/sdks/node-sdk). 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.

## What's inside?

This package provides the XMTP client SDK for React.

To keep up with the latest SDK developments, see the [Issues tab](https://github.com/xmtp/xmtp-web/issues) in this repo.

To learn more about XMTP and get answers to frequently asked questions, see the [XMTP documentation](https://xmtp.org/docs).

## What's inside?

### Hooks

These hooks are mostly bindings to the [`xmtp-js` SDK](https://github.com/xmtp/xmtp-js) that expose the underlying data in a React way.
Expand Down

0 comments on commit b87015c

Please sign in to comment.