From 879f679a99fad5bfc3632610babe33279d11a659 Mon Sep 17 00:00:00 2001 From: Amolith Date: Tue, 21 Oct 2025 17:53:48 -0600 Subject: [PATCH] docs: add -h to readme --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f46ebe1f349058e8aa1bc1c6c355b947c98364b5 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ + + +``` +$ 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 " + + # 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 +```