sliding-sync/client/README.md
Kegan Dougal f79eb957de client: Move sliding sync loop code to sync.js
- use callbacks to propagate room data and notices when the response has been processed.
2022-02-24 11:10:12 +00:00

16 lines
626 B
Markdown

## Sliding Sync Client
![Client](./client.png)
This is a basic JS client for Sliding Sync. It is designed to be easily readable and is aimed at
developers who want to implement Sliding Sync into their clients. The client is broken up into:
- `devtools.js` : Code for showing developer statistics.
- `index.js` : Entry point for the client and hooks into the DOM.
- `render.js` : Code to convert data structures into DOM nodes.
- `sync.js` : Sliding Sync code.
To understand sliding sync, you need to read `index.js` and `sync.js`. The rest of it can be ignored.
The client code uses Prettier as a code formatter.