# AGENTS.md

A fast, simple & powerful blog framework, powered by Node.js.

## Setup

```
npm ci
```

## Commands

```
npm run build            # produce a build
npm run test             # run the test suite, must pass before any commit
npm run prepublishOnly
npm run clean
npm run eslint
npm run test-cov
npm run prepare
```

## Layout

- `lib/`  149 source files
- `test/` 124 source files

## Conventions

- Tests live alongside the code they cover, following `test/benchmark.js`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/benchmark.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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.