diff --git a/README.md b/README.md index 24336a60..8c18b13e 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,14 @@ To learn more about the contents of this repository, see this README and the REA ### Packages - [`eslint-config-xmtp-web`](https://github.com/xmtp/xmtp-web/blob/main/packages/eslint-config-xmtp-web): An opinionated ESLint configuration for XMTP web projects -- [`react-sdk`](https://github.com/xmtp/xmtp-web/blob/main/packages/react-sdk): React XMTP client SDK +- [`react-sdk`](https://github.com/xmtp/xmtp-web/blob/main/packages/react-sdk): XMTP React client SDK +- [`frames-client`](https://github.com/xmtp/xmtp-web/blob/main/packages/frames-client): XMTP Open Frames client ### Examples -- [`react-vite`](https://github.com/xmtp/xmtp-web/blob/main/examples/react-vite): A quickstart example app using [React](https://react.dev/), [Vite](https://vitejs.dev/), and [RainbowKit](https://www.rainbowkit.com/) +- [`react-vite`](https://github.com/xmtp/xmtp-web/blob/main/examples/react-vite): An example app using [React](https://react.dev/), [RainbowKit](https://www.rainbowkit.com/), and [Vite](https://vitejs.dev/). +- [`nextjs`](https://github.com/xmtp/xmtp-web/blob/main/examples/nextjs): An example app using [React](https://react.dev/), [RainbowKit](https://www.rainbowkit.com/), and [Next.js](https://nextjs.org/). +- [`remix`](https://github.com/xmtp/xmtp-web/blob/main/examples/remix): An example app using [React](https://react.dev/), [RainbowKit](https://www.rainbowkit.com/), and [Remix](https://remix.run/). ## Contributing diff --git a/packages/react-sdk/README.md b/packages/react-sdk/README.md index 2a9c61b6..2e60776f 100644 --- a/packages/react-sdk/README.md +++ b/packages/react-sdk/README.md @@ -21,15 +21,24 @@ These hooks are mostly bindings to the [`xmtp-js` SDK](https://github.com/xmtp ## Install +The XMTP React SDK requires React, the XMTP JS SDK, and several content types. + +**NPM** + +```bash +npm install react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply +``` + +**PNPM** + ```bash -# npm -npm install @xmtp/react-sdk +pnpm install react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply +``` -# pnpm -pnpm install @xmtp/react-sdk +**Yarn** -# yarn -yarn add @xmtp/react-sdk +```bash +yarn add react @xmtp/react-sdk @xmtp/xmtp-js @xmtp/content-type-reaction @xmtp/content-type-remote-attachment @xmtp/content-type-reply ``` ### Buffer polyfill