Summary
The zamsync project command was added in Phase 11 but the README does not mention it yet. A new contributor can fill this gap with a pure documentation change -- no Rust required.
Context and motivation
zamsync project reads the local WAL and inserts events into a SQLite database, making them queryable with standard SQL tools. Anyone evaluating ZamSync for a real deployment will want to know this exists.
Exact task
Add a "Projecting to SQLite" section to README.md, after the existing "CLI Quick Start" section. It should cover:
- Basic usage:
zamsync project <data-dir>
- Custom output path:
zamsync project <data-dir> --target sqlite://path/to/output.db
- Dry run:
zamsync project <data-dir> --dry-run
- Batch size tuning:
--batch-size 500
- Expected output format (lines like
3 projected, 0 already present)
Acceptance criteria
- README renders correctly on GitHub (check with a local Markdown previewer)
- All flags shown match what
zamsync project --help actually prints
- No em dashes (
-- not -- in prose; use hyphens for flags)
Estimated effort
~1 h -- small (one function, one test)
Summary
The
zamsync projectcommand was added in Phase 11 but the README does not mention it yet. A new contributor can fill this gap with a pure documentation change -- no Rust required.Context and motivation
zamsync projectreads the local WAL and inserts events into a SQLite database, making them queryable with standard SQL tools. Anyone evaluating ZamSync for a real deployment will want to know this exists.Exact task
Add a "Projecting to SQLite" section to
README.md, after the existing "CLI Quick Start" section. It should cover:zamsync project <data-dir>zamsync project <data-dir> --target sqlite://path/to/output.dbzamsync project <data-dir> --dry-run--batch-size 5003 projected, 0 already present)Acceptance criteria
zamsync project --helpactually prints--not--in prose; use hyphens for flags)Estimated effort
~1 h -- small (one function, one test)