@xmtp/node-sdk 6.2.0-dev.999b077 → 6.2.0-dev.9f72722

package/README.md

@@ -8,6 +8,26 @@ To keep up with the latest SDK developments, see the [Issues tab](https://githu
 
 To learn how to use the XMTP client SDK for Node, see [Get started with the XMTP Node SDK](https://docs.xmtp.org/sdks/node).
 
+## Backend configuration
+
+Pass `backendUrl` to `Client.create` or `Client.build`. The URL must include
+`http://` or `https://`. There is no default backend URL.
+
+```typescript
+const client = await Client.create(signer, {
+  backendUrl: "http://127.0.0.1:5050",
+  env: "local",
+  appVersion: "my-app/1.0.0",
+});
+```
+
+`env` is an optional string. It only sets the label in the default database file
+name, `xmtp-<env>-<inboxId>.db3`. If omitted, the label is `default`.
+The API-client cache key is `<backendUrl>|<appVersion>`.
+Use `createBackend({ backendUrl, env, appVersion })` to build a backend for static
+client methods. The `topic` getters return the backend topic bytes as hex.
+File archives use `createArchive`, `importArchive`, and `archiveMetadata`.
+
 ## Requirements
 
 - Node.js 20+
@@ -15,19 +35,19 @@ To learn how to use the XMTP client SDK for Node, see [Get started with the XMTP
 
 ## Install
 
-**NPM**
+### NPM
 
 ```bash
 npm install @xmtp/node-sdk
 ```
 
-**PNPM**
+### PNPM
 
 ```bash
 pnpm install @xmtp/node-sdk
 ```
 
-**Yarn**
+### Yarn
 
 ```bash
 yarn add @xmtp/node-sdk
@@ -35,7 +55,7 @@ yarn add @xmtp/node-sdk
 
 ## Developing
 
-Run `yarn dev` to build the SDK and watch for changes, which will trigger a rebuild.
+For repository development, run `just install` once, then run `just js build`.
 
 ## Testing
 
@@ -43,10 +63,9 @@ For testing setup instructions, see our [testing guidelines](https://github.com/
 
 ### Useful commands
 
-- `yarn build`: Builds the SDK
-- `yarn clean`: Removes `node_modules`, `dist`, and `.turbo` folders
-- `yarn test`: Runs all tests
-- `yarn typecheck`: Runs `tsc`
+- `just js build`: Builds the SDKs.
+- `just js test`: Runs all SDK tests.
+- `just js check`: Runs TypeScript checks.
 
 ## Breaking revisions