From 22140253fe7a28d6622cd848c508615861856116 Mon Sep 17 00:00:00 2001 From: nvms Date: Thu, 17 Apr 2025 17:14:33 -0400 Subject: [PATCH] README --- .github/workflows/mesh-tests.yml | 39 -------------------------------- packages/mesh/README.md | 11 --------- 2 files changed, 50 deletions(-) delete mode 100644 .github/workflows/mesh-tests.yml diff --git a/.github/workflows/mesh-tests.yml b/.github/workflows/mesh-tests.yml deleted file mode 100644 index 98e0bb2..0000000 --- a/.github/workflows/mesh-tests.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: mesh-tests - -on: - push: - paths: - - 'packages/mesh/**' - pull_request: - paths: - - 'packages/mesh/**' - -jobs: - test-mesh: - runs-on: ubuntu-latest - services: - redis: - image: redis:7 - ports: - - 6379:6379 - options: >- - --health-cmd "redis-cli ping" - --health-interval 5s - --health-timeout 5s - --health-retries 5 - - steps: - - uses: actions/checkout@v3 - - - name: install bun - uses: oven-sh/setup-bun@v1 - - - name: install deps - working-directory: packages/mesh - run: bun install - - - name: run tests - working-directory: packages/mesh - env: - REDIS_URL: redis - run: bun test diff --git a/packages/mesh/README.md b/packages/mesh/README.md index 4ac6002..3540fce 100644 --- a/packages/mesh/README.md +++ b/packages/mesh/README.md @@ -177,17 +177,6 @@ Unsubscribe when no longer needed: await client.unsubscribe("chat:room1"); ``` -#### Return Value - -`client.subscribe(...)` returns an object: - -```ts -{ - success: boolean; // Whether the subscription was accepted - history: string[]; // Most recent messages (newest first) -} -``` - This feature is great for: - Real-time chat and collaboration