Skip to content

Commit

Permalink
Merge pull request #218 from xmtp/rygine/update-readme
Browse files Browse the repository at this point in the history
Update READMEs
  • Loading branch information
rygine authored Mar 20, 2024
2 parents 844d858 + 42fbf19 commit ab021d0
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
21 changes: 15 additions & 6 deletions packages/react-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ab021d0

Please sign in to comment.