diff --git a/README.rst b/README.rst index c94ac62d..18d91d64 100644 --- a/README.rst +++ b/README.rst @@ -39,10 +39,15 @@ Commit Check Overview -------- -**Commit Check** (aka **cchk**) is the most comprehensive open-source tool for enforcing Git commit standards — including commit messages, branch naming, author identity, commit signoff, and more — helping teams maintain consistency and compliance across every repository. +**Commit Check** is a lightweight policy engine for Git commit metadata. -As a lightweight, free alternative to GitHub Enterprise `Metadata restrictions `_ -and Bitbucket's paid `Yet Another Commit Checker `_ plugin, Commit Check integrates DevOps principles and Infrastructure as Code (IaC) practices for a modern workflow. +It validates commit messages, branch names, author identity, signoff trailers, +and push safety — using one versioned TOML policy across local hooks, CI, +GitHub Actions, and AI automation. + +- **One policy file:** ``cchk.toml`` +- **Multiple enforcement points:** CLI, pre-commit, CI / GitHub Actions +- **Machine-readable output:** JSON + Python API for automation and AI agents .. image:: https://github.com/commit-check/commit-check/raw/main/docs/demo.gif :alt: commit-check demo