diff --git a/README.md b/README.md index f1cfb95..9b8fb2a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # git-check-assertions -🚧 Merely a proof-of-concept right now. - I recently wrote two blogs posts arguing that there might be some value in writing verifiable claims, i.e. assertions, inside of our commit messages: * [Should we start writing verifiable claims in commit message?](https://sven.memcmp.org/2026-02-19-should-we-start-writing-verifiable-claims-in-commit-messages/) @@ -11,6 +9,8 @@ This is a simple verifier for such assertions. You include a small bash script inside your commit messages, and `git-check-assertions` will then check out every commit (from the point that your branch diverged from `main`), and verify that the script in the commit message runs successfully. +For a real-world example, check out the commits in [this pull request](https://codeberg.org/svenvanheugten/git-check-assertions/pulls/8), where `git-check-assertions` is used on itself. + ⚠️ Only run this on repositories and branches that you trust, since the `bash` scripts in the commit messages can do whatever they want. ## Installation