hakowork/charm
3
0
Fork 0
mirror of https://github.com/littensy/charm.git synced 2026-10-22 12:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: capitalize headers

Browse source
This commit is contained in:
littensy 2025-11-03 00:51:34 -08:00
parent 682b3dfcff
commit 90399a816f
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -52,12 +52,12 @@
- [`mapped(getter, mapper)`](#mappedgetter-mapper) - [`mapped(getter, mapper)`](#mappedgetter-mapper)
- [`onCleanup(callback, failSilently?)`](#oncleanupcallback-failsilently) - [`onCleanup(callback, failSilently?)`](#oncleanupcallback-failsilently)
- [`atom(initialValue, equals?)`](#atominitialvalue-equals) - [`atom(initialValue, equals?)`](#atominitialvalue-equals)
- [Client-server sync](#client-server-sync) - [Client-Server Sync](#client-server-sync)
- [Installation](#installation-1) - [Installation](#installation-1)
- [Quick start](#quick-start) - [Quick Start](#quick-start)
- [Server API](#config) - [Server API](#config)
- [Client API](#clientaddsignalssetters) - [Client API](#clientaddsignalssetters)
- [Sync caveats](#sync-caveats) - [Sync Caveats](#sync-caveats)
- [Examples](#examples) - [Examples](#examples)
</details> </details>
@ -551,7 +551,7 @@ Global flags that customize the behavior of Charm. The `strict` and `frozen` fla
--- ---
## Client-server sync ## Client-Server Sync
### Installation ### Installation
@ -566,7 +566,7 @@ pnpm add @rbxts/charm-sync
CharmSync = "littensy/charm-sync@VERSION" CharmSync = "littensy/charm-sync@VERSION"
``` ```
### Quick start ### Quick Start
Start by specifying the signals that the server should sync to clients. For this example, we'll use the first and last name signals: Start by specifying the signals that the server should sync to clients. For this example, we'll use the first and last name signals:
@ -784,7 +784,7 @@ end)
--- ---
### Sync caveats ### Sync Caveats
Charm Sync will only send clients the differences between the current state and the previously-synced state, which is a practice called _delta compression_. In this case, tables are recursively scanned for changes, and unchanged properties are omitted by setting them to `nil`. Charm Sync will only send clients the differences between the current state and the previously-synced state, which is a practice called _delta compression_. In this case, tables are recursively scanned for changes, and unchanged properties are omitted by setting them to `nil`.