From 464bbe4f526570db766fb1e653af432899cc072a Mon Sep 17 00:00:00 2001 From: Beatriz Vieira Date: Wed, 4 Dec 2019 20:57:05 -0300 Subject: [PATCH] docs: add usage on docs --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 639309a..e00795d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Semantic version for git ### Installing -Comming soon... +Download the latest release and add the binary on your path ## Running @@ -26,6 +26,32 @@ git sv current-version git sv next-version ``` +### Usage + +```bash +NAME: + sv - semantic version for git + +USAGE: + git-sv [global options] command [command options] [arguments...] + +VERSION: + 1.0.0 + +COMMANDS: + current-version, cv get last released version from git + next-version, nv generate the next version based on git commit messages + commit-log, cl list all commit logs since last version as jsons + release-notes, rn generate release notes + tag, tg generate tag with version based on git commit messages + help, h Shows a list of commands or help for one command + +GLOBAL OPTIONS: + --help, -h show help + --version, -v print the version + +``` + ## Development ### Makefile