mirror of
https://github.com/thegeeklab/git-sv.git
synced 2024-11-21 22:10:39 +00:00
docs: add usage on docs
This commit is contained in:
parent
137dca4081
commit
464bbe4f52
28
README.md
28
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
|
||||
|
Loading…
Reference in New Issue
Block a user