diff --git a/README.md b/README.md index cb1866e..99e13cf 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ steplock sits on top of the [polyhook](https://github.com/tupe12334/polyhook) SDK. It intercepts hook events and gates actions behind a sequential checklist — one question per invocation, acknowledged by the agent, persisted to disk. +**[Installation →](Installation.md)** · **[Architecture →](Architecture.md)** · **[Contributing →](CONTRIBUTING.md)** + --- ## The Problem @@ -92,6 +94,10 @@ stateDiagram-v2 skip_reason : Describe why test coverage was skipped. ``` +See [`examples/git-push-quality-gate/`](examples/git-push-quality-gate/) for a complete working example. + +--- + ## Editor support **`config.toml`** — add the `#:schema` hint. [Taplo](https://taplo.tamasfe.dev) (via [Even Better TOML](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml)) provides autocomplete and inline validation.