# AGENTS.md

⚛️ Fast 3kB React alternative with the same modern API. Components & Virtual DOM.

## Setup

```
npm ci
```

## Commands

```
npm run dev         # run locally
npm run build       # produce a build
npm run test        # run the test suite, must pass before any commit
npm run lint        # lint
npm run format      # format
npm run prepare
npm run postbuild
npm run dev:hooks
```

## Layout

- `compat/` 73 source files
- `test/`   55 source files
- `demo/`   39 source files
- `hooks/`  20 source files
- `debug/`  19 source files
- `src/`    17 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/build-test.yml`.
- CI defines what passing means. See `.github/workflows/benchmarks.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `src/dom.d.ts` is 110KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.