From 00a7ccd363ae877bef8bd17f390de30fcf61c821 Mon Sep 17 00:00:00 2001 From: Beatriz Vieira Date: Sat, 1 Feb 2020 19:02:03 -0300 Subject: [PATCH] docs: better usage on readme --- README.md | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index c1aaf6b..8589459 100644 --- a/README.md +++ b/README.md @@ -42,30 +42,27 @@ git sv next-version #### Usage +use `--help` or `-h` to get usage information, dont forget that some commands have unique options too + ```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 +# sv help +git-sv -h +# sv release-notes command help +git-sv rn -h ``` +##### Available commands + +| Variable | description| +| --------- | ----------| +| 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 | + ## Development ### Makefile