diff --git a/examples/react-vite-browser-sdk/README.md b/examples/react-vite-browser-sdk/README.md index 3795dcc31..740c222c3 100644 --- a/examples/react-vite-browser-sdk/README.md +++ b/examples/react-vite-browser-sdk/README.md @@ -2,9 +2,9 @@ Use this React Vite example app as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with. -The app is built using the [React XMTP client SDK](/packages/react-sdk/README.md), [React](https://react.dev/), [Vite](https://vitejs.dev/), and [RainbowKit](https://www.rainbowkit.com/). +The app is built using the [XMTP client SDK for browsers](/sdks/browser-sdk/README.md), [React](https://react.dev/), and [Vite](https://vitejs.dev/). -To keep up with the latest example app developments, see the [Issues tab](https://github.com/xmtp/xmtp-web/issues) in this repo. +To keep up with the latest example app developments, see the [Issues tab](https://github.com/xmtp/xmtp-js/issues) in this repo. To learn more about XMTP and get answers to frequently asked questions, see the [XMTP documentation](https://xmtp.org/docs). @@ -14,15 +14,11 @@ This example app isn't a complete solution. For example, the list of conversatio ## Developing -1. In `packages/react-sdk`, run `yarn build` to build the React SDK. -2. In `examples/react-vite`, run `yarn dev` to start the development server. +1. In `sdks/browser-sdk`, run `yarn build` to build the browser SDK. +2. In `examples/react-vite-browser-sdk`, run `yarn dev` to start the development server. ## Useful commands -- `yarn build`: Builds the example app - `yarn clean`: Removes `node_modules`, `dist`, and `.turbo` folders - `yarn dev`: Launches the example app and watches for changes, which will trigger a rebuild -- `yarn format`: Runs prettier format and write changes -- `yarn format:check`: Runs prettier format check -- `yarn lint`: Runs ESLint - `yarn typecheck`: Runs `tsc` diff --git a/examples/react-vite-browser-sdk/package.json b/examples/react-vite-browser-sdk/package.json index 102500c6b..99e470cf8 100644 --- a/examples/react-vite-browser-sdk/package.json +++ b/examples/react-vite-browser-sdk/package.json @@ -7,7 +7,6 @@ "clean": "rm -rf .turbo && rm -rf node_modules && yarn clean:dist", "clean:dist": "rm -rf dist", "dev": "vite", - "quickstart": "yarn dev", "typecheck": "tsc" }, "dependencies": { diff --git a/sdks/browser-sdk/README.md b/sdks/browser-sdk/README.md index 9c29c43e2..ae3d960a3 100644 --- a/sdks/browser-sdk/README.md +++ b/sdks/browser-sdk/README.md @@ -103,7 +103,7 @@ The following table provides the deprecation schedule. | -------------------------------------------------------------- | --------- | --------------- | --------- | | There are no deprecations scheduled for this SDK at this time. | | | | -Bug reports, feature requests, and PRs are welcome in accordance with theseĀ [contribution guidelines](https://github.com/xmtp/xmtp-web/blob/main/CONTRIBUTING.md). +Bug reports, feature requests, and PRs are welcome in accordance with theseĀ [contribution guidelines](https://github.com/xmtp/xmtp-js/blob/main/CONTRIBUTING.md). ## Developing