preact-sigma 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,19 @@
|
|
|
4
4
|
|
|
5
5
|
You define a reusable state type once, then create instances wherever they make sense: inside components, in shared modules, or in plain TypeScript code. Each instance exposes readonly public state, tracked derived reads, imperative actions, and optional setup and event APIs.
|
|
6
6
|
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
To add `preact-sigma` to your project:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install preact-sigma
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
If you use AI coding agents, this repo also includes agent-oriented guidance:
|
|
16
|
+
|
|
17
|
+
- [llms.txt](./llms.txt) provides a compact overview of the API and recommended patterns.
|
|
18
|
+
- Companion skills are available via `npx skills add alloc/preact-sigma`.
|
|
19
|
+
|
|
7
20
|
## What It Is
|
|
8
21
|
|
|
9
22
|
At its core, `preact-sigma` lets you describe a stateful model as a constructor:
|