Change summary
README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 55 insertions(+)
Detailed changes
@@ -0,0 +1,55 @@
+<!--
+SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
+
+SPDX-License-Identifier: CC0-1.0
+-->
+
+```
+$ formatted-commit -h
+
+ formatted-commit helps you create well-formatted Git commits that follow
+ the Conventional Commits specification with proper subject length validation,
+ body wrapping, and trailer formatting.
+
+ USAGE
+
+
+ formatted-commit [--flags]
+
+
+ EXAMPLES
+
+
+ # With co-author
+ formatted-commit -t feat -m "do a thing" -t "Crush <crush@charm.land>"
+
+ # Breaking change with longer body
+ formatted-commit -t feat -m "do a thing that borks a thing" -B "$(cat <<'EOF'
+ Multi-line
+ - Body
+ - Here
+
+ This is what borked because of new shiny, this is how migrate
+ EOF
+ )"
+
+ # Including scope for more precise changes
+ formatted-commit -t refactor -s "web/git-bug" -m "fancy shmancy" \
+ -b "Had to do a weird thing because..."
+
+
+ COMMANDS
+
+ help [command] Help about any command
+
+ 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
+```