From e993afc07f45dda089115a23e3b289c56205c4b7 Mon Sep 17 00:00:00 2001 From: nvms Date: Fri, 18 Apr 2025 10:11:30 -0400 Subject: [PATCH] README --- packages/mesh/README.md | 49 +++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/packages/mesh/README.md b/packages/mesh/README.md index cee2256..da1bd04 100644 --- a/packages/mesh/README.md +++ b/packages/mesh/README.md @@ -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