README.md

Take the kindstore course

This course is for readers who already know TypeScript, Zod, and basic SQLite concepts, but want the shortest path to using kindstore idiomatically.

Use the course for sequencing and tradeoffs, not exact API reference:

• Read ../context.md for the stable mental model.
• Run examples/basic-usage.ts, examples/indexed-queries.ts, and examples/metadata-and-batch.ts for runnable workflows.
• Use ../../dist/index.d.mts for exact signatures.

The guides are ordered. Each one builds on the previous one.

1. 01-modeling-kinds.md Define kinds, choose stable tags, and decide which fields should be queryable.
2. 02-reading-writing-and-updating.md Short checkpoint for choosing between create, put, update, get, and resolve.
3. 03-indexed-queries.md Build query shapes around declared indexes, ordering, and lazy iteration.
4. 04-metadata-batches-and-raw-sql.md Short checkpoint for metadata, transactions, and the raw SQLite escape hatch.
5. 05-payload-migrations.md Evolve a kind's payload shape with eager startup migrations.
6. 06-structural-migrations.md Handle renames, drops, and tag changes explicitly at the store level.

If you are maintaining kindstore itself rather than using it, start with the system docs in ../architecture-overview.md.