Skip to content

Commit 568ed99

Browse files
committed
docs(readme): lead with what it is, where it fits and how to upgrade
Moves the development notes and the how-it-works paragraph to CONTRIBUTING.md so the README covers install, quickstart, reference, Interchange wiring and the 0.1 upgrade path. Every tsx block typechecks against the packed build.
1 parent 5d0a253 commit 568ed99

2 files changed

Lines changed: 222 additions & 223 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ registry and developed with [bun](https://bun.sh) as its package manager and tas
55
Read [ARCHITECTURE.md](./ARCHITECTURE.md) first — most of the rules below only make sense
66
once that is clear.
77

8+
## How it works
9+
10+
Components never fetch; data arrives as props. The root entry is generated re-exports
11+
only, and the package is side-effect free apart from its CSS, so either import style
12+
tree-shakes. Tokens and keyframes live in `theme.css`; `styles.css` is the prebuilt sheet
13+
for hosts that do not run Tailwind. [PRODUCT.md](./PRODUCT.md) covers why the library
14+
exists and [IMPLEMENTATION.md](./IMPLEMENTATION.md) the toolchain and peers.
15+
816
## Getting set up
917

1018
```sh

0 commit comments

Comments
 (0)