@xmtp/browser-sdk 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 XMTP (xmtp.org)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# XMTP client SDK for browsers
+
+This package provides the XMTP client SDK for browsers.
+
+To keep up with the latest SDK 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).
+
+> [!CAUTION]
+> This SDK is currently in alpha. The API is subject to change and it is not yet recommended for production use.
+
+## Requirements
+
+### Response headers
+
+Server response headers must be set to the following values:
+
+- `Cross-Origin-Embedder-Policy: require-corp`
+- `Cross-Origin-Opener-Policy: same-origin`
+
+### Bundlers
+
+This SDK uses a WebAssembly (WASM) module and bundlers must be configured properly to handle it.
+
+#### Vite
+
+Add the following to `vite.config.ts`:
+
+```typescript
+import { defineConfig } from "vite";
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  optimizeDeps: {
+    exclude: ["@xmtp/wasm-bindings"],
+  },
+});
+```
+
+#### Next.js
+
+Add the following to `next.config.mjs`:
+
+```typescript
+const nextConfig = {
+  serverComponentsExternalPackages: ["@xmtp/wasm-bindings"],
+};
+
+export default nextConfig;
+```
+
+## Install
+
+**NPM**
+
+```bash
+npm install @xmtp/browser-sdk
+```
+
+**PNPM**
+
+```bash
+pnpm install @xmtp/browser-sdk
+```
+
+**Yarn**
+
+```bash
+yarn add @xmtp/browser-sdk
+```
+
+## Reference docs
+
+Access the XMTP client browser SDK [reference documentation](TBD).
+
+## Usage
+
+Check out our [official documentation](https://xmtp.org/docs/build/get-started/overview) to get started developing with XMTP.
+
+## XMTP network environments
+
+XMTP provides `production`, `dev`, and `local` network environments to support the development phases of your project. To learn more about these environments, see our [official documentation](https://xmtp.org/docs/build/authentication#environments).
+
+> **Important**  
+> When you [create a client](https://xmtp.org/docs/build/authentication#create-a-client), it connects to the XMTP `dev` environment by default. To learn how to use the `env` parameter to set your client's network environment, see [Configure the client](https://xmtp.org/docs/build/authentication#configure-the-client).
+
+## Breaking revisions
+
+Because this SDK is in active development, you should expect breaking revisions that might require you to adopt the latest SDK release to enable your app to continue working as expected.
+
+XMTP communicates about breaking revisions in the [XMTP Discord community](https://discord.gg/xmtp), providing as much advance notice as possible. Additionally, breaking revisions in a release are described on the [Releases page](https://github.com/xmtp/xmtp-js/releases).
+
+## Deprecation
+
+Older versions of the SDK will eventually be deprecated, which means:
+
+1. The network will not support and eventually actively reject connections from clients using deprecated versions.
+2. Bugs will not be fixed in deprecated versions.
+
+The following table provides the deprecation schedule.
+
+| Announced                                                      | Effective | Minimum Version | Rationale |
+| -------------------------------------------------------------- | --------- | --------------- | --------- |
+| 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-js/blob/main/CONTRIBUTING.md).
+
+## Developing
+
+Run `yarn dev` to build the SDK and watch for changes, which will trigger a rebuild.
+
+### Useful commands
+
+- `yarn build`: Builds the SDK
+- `yarn clean`: Removes `node_modules`, `dist`, and `.turbo` folders
+- `yarn dev`: Builds the SDK and watches for changes, which will trigger a rebuild
+- `yarn test`: Runs all tests
+- `yarn typecheck`: Runs `tsc`