diff --git a/README.md b/README.md index 4e9e4b3ce0d020f434060384a5063508206ace23..ae666f3d27b0146bbd74f12519bce9c7cd35c3e4 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,10 @@ SPDX-License-Identifier: CC0-1.0 [![REUSE status](https://api.reuse.software/badge/git.secluded.site/formatted-commit)](https://api.reuse.software/info/git.secluded.site/formatted-commit) [![Go Report Card](https://goreportcard.com/badge/git.secluded.site/formatted-commit)](https://goreportcard.com/report/git.secluded.site/formatted-commit) -_Encourage LLMs towards well-formatted commits_ +CLI tool that requires conformance with the Conventional Commits specification +through flags, made for LLMs and not really for humans (but I guess you can use +this directly if you want). Humans would likely prefer, as the author does, +[meteor](https://github.com/stefanlogue/meteor). ## Installation @@ -17,7 +20,11 @@ _Encourage LLMs towards well-formatted commits_ go install git.secluded.site/formatted-commit@latest ``` -Copy/paste into wherever you tell your models how to write commits. +Copy/paste into wherever you tell your models how to write commits. I like +[Crush 💘](https://github.com/charmbracelet/crush) (and maintain [a +fork](https://git.secluded.site/crush)) and [OpenCode](https://opencode.ai/) as +the more-open options and [Amp](https://ampcode.com/) as the best/proprietary +option. ```markdown Create commits exclusively using `formatted-commit`. Try to use it normally, but if it's not in my PATH, ask me to `go install git.secluded.site/formatted-commit@latest`. It has no sub-commands and the following options: