diff --git a/README.md b/README.md index 17c8840652ccf8ea32c50807b68d84236f2f29ef..375d798445dcf4f0d2c8770af33e738fc1964581 100644 --- a/README.md +++ b/README.md @@ -32,16 +32,7 @@ indication of where the 50-character cut-off is. ## Installation -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 need both the binary and the prompt. If you don't have the binary -when the model tries to use it, it's instructed to ask you to install -it using the appropriate command. +You need _both_ the binary and the prompt. ### The binary @@ -51,26 +42,19 @@ it using the appropriate command. ```bash bin install goinstall://git.secluded.site/formatted-commit@latest ``` -- Using the [go toolchain](https://go.dev/dl) (requires tracking updates - manually, though you can check with `formatted-commit upgrade` and - apply with `formatted-commit upgrade -a`) +- Using the [go toolchain](https://go.dev/dl) (upgrade with `formatted-commit upgrade`) ```bash go install git.secluded.site/formatted-commit@latest ``` ### The prompt -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. - -
-Using bin +Paste this snippet into some section of your `~/.config/AGENTS.md` or +`~/.claude/CLAUDE.md` or whatever titled something like `## Creating git +commits`. ```markdown -Create/amend commits exclusively using `formatted-commit`. Try to use it normally, but if it's not in my PATH, ask me to `bin install goinstall://git.secluded.site/formatted-commit@latest`. It has no sub-commands and the following options: +Create/amend commits exclusively using `formatted-commit`. It has no sub-commands and the following options: -t --type Commit type (required) -s --scope Commit scope (optional) @@ -94,38 +78,6 @@ EOF ``` -
- -
-Using go install - -```markdown -Create/amend 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: - --t --type Commit type (required) --s --scope Commit scope (optional) --B --breaking Mark as breaking change (optional) --m --message Commit message (required) --b --body Commit body (optional) --T --trailer Trailer in 'Sentence-case-key: value' format (optional, repeatable) --a --add Stage all modified files before committing (optional) ---amend Amend the previous commit (optional) --h --help - - -formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -T "Assisted-by: GLM 4.6 via Crush" -b "$(cat <<'EOF' -Multi-line - -- Body -- Here - -EOF -)" - -``` - -
- ## Contributions Patch requests are in [amolith/llm-projects] on [pr.pico.sh]. You don't need a