This commit is contained in:
nvms 2025-04-18 10:11:30 -04:00
parent 663c9ab735
commit e993afc07f

View File

@ -2,30 +2,31 @@
Mesh is a command-based WebSocket framework for real-time apps—whether you're running a single server or a distributed cluster. It uses Redis to coordinate connections, rooms, and shared state across instances, with built-in support for structured commands, latency tracking, and automatic reconnection.
- [Quickstart](#quickstart)
- [Server](#server)
- [Client](#client)
- [Distributed Messaging Architecture](#distributed-messaging-architecture)
- [Redis Channel Subscriptions](#redis-channel-subscriptions)
- [Server Configuration](#server-configuration)
- [Server Publishing](#server-publishing)
- [Client Usage](#client-usage)
- [Metadata](#metadata)
- [Room Metadata](#room-metadata)
- [Record Subscriptions](#record-subscriptions)
- [Server Configuration (Read-Only)](#server-configuration-read-only)
- [Server Configuration (Writable)](#server-configuration-writable)
- [Updating Records (Server-Side)](#updating-records-server-side)
- [Updating Records (Client-Side)](#updating-records-client-side)
- [Client Usage — Full Mode (default)](#client-usage--full-mode-default)
- [Client Usage — Patch Mode](#client-usage--patch-mode)
- [Unsubscribing](#unsubscribing)
- [Versioning and Resync](#versioning-and-resync)
- [Command Middleware](#command-middleware)
- [Latency Tracking and Connection Liveness](#latency-tracking-and-connection-liveness)
- [Server-Side Configuration](#server-side-configuration)
- [Client-Side Configuration](#client-side-configuration)
- [Comparison](#comparison)
* [Quickstart](#quickstart)
* [Server](#server)
* [Client](#client)
* [Next Steps](#next-steps)
* [Distributed Messaging Architecture](#distributed-messaging-architecture)
* [Redis Channel Subscriptions](#redis-channel-subscriptions)
* [Server Configuration](#server-configuration)
* [Server Publishing](#server-publishing)
* [Client Usage](#client-usage)
* [Metadata](#metadata)
* [Room Metadata](#room-metadata)
* [Record Subscriptions](#record-subscriptions)
* [Server Configuration](#server-configuration-1)
* [Server Configuration (Writable)](#server-configuration-writable)
* [Updating Records (Server-Side)](#updating-records-server-side)
* [Updating Records (Client-Side)](#updating-records-client-side)
* [Client Usage — Full Mode (default)](#client-usage--full-mode-default)
* [Client Usage — Patch Mode](#client-usage--patch-mode)
* [Unsubscribing](#unsubscribing)
* [Versioning and Resync](#versioning-and-resync)
* [Command Middleware](#command-middleware)
* [Latency Tracking and Connection Liveness](#latency-tracking-and-connection-liveness)
* [Server-Side Configuration](#server-side-configuration)
* [Client-Side Configuration](#client-side-configuration)
* [Comparison](#comparison)
## Quickstart