diff --git a/README.md b/README.md index fb1b19e..84b400a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # Comenq -This is a generated project using [Copier](https://copier.readthedocs.io/). +Comenq is a fault-tolerant service that queues GitHub Pull Request comments. It +follows a daemon\-client model: the `comenqd` daemon enforces a 16\-minute +cooling\-off period for posting, while the `comenq` CLI simply enqueues +requests. The architecture and crate choices are described in +[docs/comenq-design.md](docs/comenq-design.md). Further guides in the +[`docs/`](docs/) directory detail testing approaches and library rationale. + +## Building and testing + +Use the provided `make` targets to manage the project: + +- `make build` – compile debug binaries in `target/debug/` +- `make release` – produce optimized release binaries +- `make test` – execute the full test suite +- `make lint` – run Clippy with warnings denied +- `make fmt` – format Rust and Markdown files + +## Running the binaries + +After building, launch the daemon and queue comments with the client: + +```bash +make build +./target/debug/comenqd & +./target/debug/comenq owner/repo 123 "Comment body" +``` + +Queued requests persist on disk and are posted sequentially by the daemon.