From 8d3c72b09ac7d09f6f0798c47666c2c02f062024 Mon Sep 17 00:00:00 2001 From: Amolith Date: Wed, 22 Oct 2025 18:58:36 -0600 Subject: [PATCH] docs: improve installation instructions --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ae666f3d27b0146bbd74f12519bce9c7cd35c3e4..9d022970c2eeea8f7fcdd9eceb701c20bc39463c 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,26 @@ this directly if you want). Humans would likely prefer, as the author does, ## Installation -```sh -go install git.secluded.site/formatted-commit@latest +As this is mostly meant for agentic coding tools, you'll need one. I like [Crush +💘](https://github.com/charmbracelet/crush) (and maintain [a +fork](https://git.secluded.site/crush)) or [OpenCode](https://opencode.ai/) as +the best more-open options and [Amp](https://ampcode.com/) as the overall best +option if you don't mind completely proprietary and paying for 100% of your API +usage. + +You may install formatted-commits manually using the following command. You may +also skip this and just add the prompt snippet; it tells the model about the +command so it can try to run it on its own or ask you to run it. + +```bash +go install git.secluded.site/formatted-commits@latest ``` -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. +Copy/paste this into wherever you tell your models how to write commits. For +Crush, that might be `~/.config/crush/CRUSH.md` or `./CRUSH.md` in a repo. For +[my Crush fork](https://git.secluded.site/crush) and Amp, that's +`~/.config/AGENTS.md`. Look up where your tool checks for rules files and put +this in a section like `## Creating git commits` or something. ```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: