From 7bbd7a0adbb3bf99492fda56315f058e2332ef18 Mon Sep 17 00:00:00 2001 From: Richard Date: Fri, 31 May 2024 00:50:29 -0700 Subject: [PATCH] docs: note key differences from reflex --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 257993b..dce3e23 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,18 @@ > [!NOTE] > The documentation is a work-in-progress! Please refer to the [examples](#🚀-examples) section for more information on how to use Charm. +## 🍀 Features + +- ⚛️ **Manage state with _atoms_.** Decompose state into small, distinct containers called _atoms_, as opposed to combining them into a single store. + +- 💪 **Minimal, yet powerful.** No concept of actions or middleware — write simple functions to read from and write to state. + +- 🔬 **Immediate updates.** Listeners run asynchronously by default, avoiding the cascading effects of deferred updates and improving responsiveness. + +- 🦄 **Like magic.** Selector functions can be subscribed to as-is — their memoization and dependencies are resolved for you. + +--- + ## 📦 Setup Install Charm for roblox-ts using your package manager of choice. @@ -40,6 +52,8 @@ Alternatively, add `littensy/charm` to your `wally.toml` file. Charm = "littensy/charm@VERSION" ``` +--- + ## 📚 API Reference ### Charm @@ -74,6 +88,8 @@ Charm = "littensy/charm@VERSION" #### `Server.hydrate(player)` +--- + ## 🚀 Examples ### Counter atom