Skip to content

Commit 3e2fee8

Browse files
authored
Docs: add table of contens and seperate cmds and opts (#20)
1 parent de79b6d commit 3e2fee8

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@
88
99
<img src="https://raw.githubusercontent.com/aichbauer/node-semantic-git-release-cli/master/media/screenshot.gif">
1010

11+
## Table of contents
12+
13+
* [Why](#why)
14+
* [Installation](#installation)
15+
* [Usage](#usage)
16+
* [Commands](#commands)
17+
* [sgr](#sgr)
18+
* [sgr recover](#sgr-recover)
19+
* [sgr version](#sgr-version)
20+
* [Options](#options)
21+
* [sgr recover --backup](#sgr-recover---backup)
22+
* [sgr --help](#sgr---help)
23+
1124
## Why?
1225

1326
Many projects need versioning. It is always the same: testing, writing the changelog, updating the version, tagging the commit, and finally releasing the new version.
@@ -47,6 +60,12 @@ $ semantic-git-release
4760
* [sgr](#sgr)
4861
* [sgr recover](#sgr-recover)
4962
* [sgr version](#sgr-version)
63+
64+
## Options
65+
66+
`semantic-git-release-cli` was build to be as simple as possible, so there are just a few options you need to know.
67+
68+
* [sgr recover --backup](#sgr-recover---backup)
5069
* [sgr --help](#sgr---help)
5170

5271
### sgr
@@ -75,8 +94,8 @@ With `sgr recover [backup]` you can recover your complete CHANGELOG.md if you ju
7594
```sh
7695
# generates the complete CHANGELOG.md
7796
$ sgr recover
78-
# generates the complete CHANGELOG.md and creates a backup of the current CHANGELOG.md in .sgr_backup
79-
$ sgr recover backup
97+
# generates the complete CHANGELOG.md, and creates a backup of the old one
98+
$ sgr recover --backup
8099
```
81100

82101
### sgr version
@@ -88,6 +107,15 @@ With `sgr version` you can display the current version of `semantic-git-release-
88107
$ sgr version
89108
```
90109

110+
### sgr recover --backup
111+
112+
With `sgr recover --backup` you can recover your complete CHANGELOG.md, and recover the old CHANGELOG.md to `.sgr_backup`.
113+
114+
```sh
115+
# generates the complete CHANGELOG.md and saves the old CHANGELOG.md to `.sgr_backup`
116+
$ sgr recover --backup
117+
```
118+
91119
### sgr --help
92120

93121
With `sgr --help` you can display usage of `semantic-git-release-cli`.

0 commit comments

Comments
 (0)