From 1d17d9602e79f65fd13c890dfb723f497dedcb75 Mon Sep 17 00:00:00 2001 From: Max Resnick Date: Tue, 23 Apr 2024 21:37:20 -0700 Subject: doc: readme updates --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 597a4ff..ea4fb6d 100644 --- a/README.md +++ b/README.md @@ -119,11 +119,15 @@ A none existant pre-release yields #### $KeyArg -`$KeyArg` allows for run time side effects on prerelease versions. This means you can bump ain integer or provide key word argument. Examples: +`$KeyArg` allows for run time side effects on prerelease versions. This means you can bump an integer or provide key word argument. Example use cases: + - add the PR/MR number to the version - add metadata for the version ```bash ❯ bumpver patch --prerelease --prerelease-fmt 'rc.$KeyArg PR_NUM.$BumpInt' --key-args PR_NUM=44 vers.txt 1.2.2-rc.44.0 + +❯ bumpver patch --prerelease --prerelease-fmt 'rc.$KeyArg USER_NAME.$BumpInt' --key-args USER_NAME=grumps vers.txt +1.2.2-rc.grumps.0 ``` -- cgit v1.2.3