docs: add prompt

Amolith created 1 week ago

Change summary

README.md | 31 ++++++++++++++++++++++++++++++-
1 file changed, 30 insertions(+), 1 deletion(-)

Detailed changes

README.md

@@ -9,12 +9,41 @@ 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_
+
 ## Installation
 
 ```sh
 go install git.secluded.site/formatted-commit@latest
 ```
 
+Copy/paste into wherever you tell your models how to write commits.
+
+```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:
+<formatted-commit_flags>
+-b --body Commit body (optional)
+-B --breaking Mark as breaking change (optional)
+-h --help Help for formatted-commit
+-m --message Commit message (required)
+-s --scope Commit scope (optional)
+-T --trailer Trailer in 'Sentence-case-key: value' format (optional, repeatable)
+-t --type Commit type (required)
+-v --version Version for formatted-commit
+</formatted-commit_flags>
+<formatted-commit_example>
+formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -T "Crush <[e-mail]>" -b "$(cat <<'EOF'
+Multi-line
+
+- Body
+- Here
+  EOF
+  )"
+</formatted-commit_example>
+```
+
 ## Usage
 
 ```text
@@ -34,7 +63,7 @@ $ formatted-commit -h
 
 
     # With co-author
-    formatted-commit -t feat -m "do a thing" -t "Crush <[e-mail]>"
+    formatted-commit -t feat -m "do a thing" -T "Crush <[e-mail]>"
 
     # Breaking change with longer body
     formatted-commit -t feat -m "do a thing that borks a thing" -B "$(cat <<'EOF'