Update Node SDK README

sdks/node-sdk/README.md

@@ -1,4 +1,49 @@
-# XMTP MLS Client
+# XMTP client SDK for Node
 
-> **Important**  
-> This package is currently in **Alpha** status. Do not use in production as the API is not final and certain functionality may not work as intended. This package only works in Node.
+This package provides the XMTP client SDK for Node.
+
+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
+
+- Node.js 20+
+
+## Install
+
+**NPM**
+
+```bash
+npm install @xmtp/node-sdk
+```
+
+**PNPM**
+
+```bash
+pnpm install @xmtp/node-sdk
+```
+
+**Yarn**
+
+```bash
+yarn add @xmtp/node-sdk
+```
+
+## 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).
+
+## 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 test`: Runs all tests
+- `yarn typecheck`: Runs `tsc`

sdks/node-sdk/package.json

@@ -43,6 +43,7 @@
     "clean:deps": "rimraf node_modules",
     "clean:dist": "rimraf dist",
     "clean:tests": "rimraf test/*.db3* ||:",
+    "dev": "yarn build --watch",
     "test": "vitest run",
     "test:cov": "vitest run --coverage",
     "typecheck": "tsc"