Add sdks workspace, update README

.github/workflows/js-sdk.yml

@@ -7,7 +7,7 @@ on:
 
   pull_request:
     paths:
-      - "packages/js-sdk/**"
+      - "sdks/js-sdk/**"
       - ".github/workflows/js-sdk.yml"
       - "dev/**"
       - ".node-version"
@@ -33,7 +33,7 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Typecheck
-        run: yarn turbo run typecheck --filter='./packages/js-sdk'
+        run: yarn turbo run typecheck --filter='./sdks/js-sdk'
 
   lint:
     name: Lint
@@ -51,7 +51,7 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Lint
-        run: yarn turbo run lint --filter='./packages/js-sdk'
+        run: yarn turbo run lint --filter='./sdks/js-sdk'
 
   test:
     name: Test
@@ -73,7 +73,7 @@ jobs:
       - name: Sleep for 5 seconds
         run: sleep 5s
       - name: Run tests
-        run: yarn turbo run test --filter='./packages/js-sdk'
+        run: yarn turbo run test --filter='./sdks/js-sdk'
 
   build:
     name: Build
@@ -91,4 +91,4 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Build
-        run: yarn turbo run build --filter='./packages/js-sdk'
+        run: yarn turbo run build --filter='./sdks/js-sdk'

.github/workflows/mls-client.yml

@@ -7,7 +7,7 @@ on:
 
   pull_request:
     paths:
-      - "packages/mls-client/**"
+      - "sdks/mls-client/**"
       - ".github/workflows/mls-client.yml"
       - "dev/**"
       - ".node-version"
@@ -33,7 +33,7 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Typecheck
-        run: yarn turbo run typecheck --filter='./packages/mls-client'
+        run: yarn turbo run typecheck --filter='./sdks/mls-client'
 
   lint:
     name: Lint
@@ -51,7 +51,7 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Lint
-        run: yarn turbo run lint --filter='./packages/mls-client'
+        run: yarn turbo run lint --filter='./sdks/mls-client'
 
   test:
     name: Test
@@ -73,7 +73,7 @@ jobs:
       - name: Sleep for 5 seconds
         run: sleep 5s
       - name: Run tests
-        run: yarn turbo run test --filter='./packages/mls-client'
+        run: yarn turbo run test --filter='./sdks/mls-client'
 
   build:
     name: Build
@@ -91,4 +91,4 @@ jobs:
       - name: Install dependencies
         run: yarn
       - name: Build
-        run: yarn turbo run build --filter='./packages/mls-client'
+        run: yarn turbo run build --filter='./sdks/mls-client'

.gitignore

@@ -69,4 +69,4 @@ next-env.d.ts
 .cache
 
 # Benchmark results
-packages/js-sdk/bench/results
+sdks/js-sdk/bench/results

.vscode/settings.json

@@ -15,7 +15,6 @@
   "editor.tabSize": 2,
   "editor.detectIndentation": false,
   "files.insertFinalNewline": true,
-  "cSpell.words": ["Ciphertext", "Waku", "authn"],
   "eslint.workingDirectories": [
     {
       "mode": "auto"

README.md

@@ -1,14 +1,14 @@
 # XMTP TypeScript
 
-This is the official repository for XMTP TypeScript SDKs and content types, powered by [Turborepo](https://turbo.build/repo). All content types can be used with these SDKs.
+This is the official repository for XMTP client SDKs, content types, and packages, written in TypeScript and powered by [Turborepo](https://turbo.build/repo).
 
-To learn more about the contents of this repository, see this README and the READMEs provided in workspace directories.
+To learn more about the contents of this repository, see this README and the READMEs provided in each workspace directory.
 
 ## What's inside?
 
 ### SDKs
 
-- [`js-sdk`](https://github.com/xmtp/xmtp-js/blob/main/packages/js-sdk): XMTP JS client SDK for Node and the browser
+- [`js-sdk`](https://github.com/xmtp/xmtp-js/blob/main/sdks/js-sdk): XMTP JS client SDK for Node and the browser
 
 ### Content types
 

package.json

@@ -5,6 +5,7 @@
   "workspaces": [
     "content-types/*",
     "packages/*",
+    "sdks/*",
     "shared/*"
   ],
   "scripts": {

packages/js-sdk/package.json → sdks/js-sdk/package.json

@@ -66,7 +66,7 @@
     "bench": "yarn build:bench && node dist/bench/index.cjs",
     "build": "yarn clean:dist && rollup -c",
     "build:bench": "rollup -c rollup.config.bench.js",
-    "build:docs": "cd ../../ && yarn build && cd packages/js-sdk && yarn clean:docs && mkdir -p tmp && cp README.md tmp/ && sed -i.bak '/badge.svg/d' tmp/README.md && typedoc",
+    "build:docs": "yarn clean:docs && mkdir -p tmp && cp README.md tmp/ && sed -i.bak '/badge.svg/d' tmp/README.md && typedoc",
     "clean": "rimraf .turbo &&yarn clean:artifacts && yarn clean:dist && yarn clean:docs && yarn clean:deps",
     "clean:artifacts": "rimraf docs tmp package.tgz",
     "clean:deps": "rimraf node_modules",

yarn.lock

@@ -2704,9 +2704,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@xmtp/mls-client@workspace:packages/mls-client":
+"@xmtp/mls-client@workspace:sdks/mls-client":
   version: 0.0.0-use.local
-  resolution: "@xmtp/mls-client@workspace:packages/mls-client"
+  resolution: "@xmtp/mls-client@workspace:sdks/mls-client"
   dependencies:
     "@rollup/plugin-json": "npm:^6.1.0"
     "@rollup/plugin-typescript": "npm:^12.1.0"
@@ -2813,9 +2813,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@xmtp/xmtp-js@workspace:^, @xmtp/xmtp-js@workspace:packages/js-sdk":
+"@xmtp/xmtp-js@workspace:^, @xmtp/xmtp-js@workspace:sdks/js-sdk":
   version: 0.0.0-use.local
-  resolution: "@xmtp/xmtp-js@workspace:packages/js-sdk"
+  resolution: "@xmtp/xmtp-js@workspace:sdks/js-sdk"
   dependencies:
     "@metamask/providers": "npm:^17.1.1"
     "@noble/secp256k1": "npm:1.7.1"