mirror of
https://github.com/thegeeklab/git-sv.git
synced 2024-11-12 15:00:39 +00:00
docs: better usage on readme
This commit is contained in:
parent
7ea9306fc4
commit
00a7ccd363
37
README.md
37
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
|
||||
|
Loading…
Reference in New Issue
Block a user