From fe5517143244c5b18d073377c146dd9f4dc7b520 Mon Sep 17 00:00:00 2001 From: Richard Date: Mon, 25 Mar 2024 02:21:38 -0700 Subject: [PATCH] docs: reformat api reference --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ee858a4..4985450 100644 --- a/README.md +++ b/README.md @@ -45,39 +45,41 @@ Add `littensy/charm` to your `wally.toml` file. Charm = "littensy/charm@VERSION" ``` -## 📚 Documentation +## 📚 API Reference -### `atom(state)` +### Charm -### `derive(atom, comparator?)` +#### `atom(state)` -### `subscribe(atom, listener)` +#### `effect(callback)` -### `effect(callback)` +#### `subscribe(atom, listener)` -### `observe(atom, observer)` +#### `derive(atom, comparator?)` -### `mapAtom(atom, mapper)` +#### `observe(atom, observer)` -## 📚 React API +#### `mapAtom(atom, mapper)` -### `useAtom(atom, selector?)` +### React -### `useAtomState(atom)` +#### `useAtom(atom, selector?)` -### `useSetAtom(atom)` +#### `useAtomState(atom)` -## 📚 Sync API +#### `useSetAtom(atom)` -### `sync.client(options)` +### Sync -### `sync.server(options)` +#### `sync.client(options)` -### `Client.sync(payload)` +#### `Client.sync(payload)` -### `Server.onSync(callback)` +#### `sync.server(options)` -### `Server.hydrate(player)` +#### `Server.onSync(callback)` + +#### `Server.hydrate(player)` ## 🚀 Examples