Skip to content

Commit fc739da

Browse files
committed
Docs: improved why
1 parent 55a7dac commit fc739da

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111

1212
## Why?
1313

14-
Many projects got different git commit rules. It is hard to remember them all.
14+
Many projects got different git commit rules. It is hard to remember them all. Usually you start with `git commit -m "`, and then? You have to think about the projects commit guidelines.
15+
16+
`sgc` will take care of the commit guidelines, so you can focus on the more important stuff: **code**
1517

1618
## Installation
1719

@@ -25,13 +27,13 @@ $ yarn add global semantic-git-commit-cli
2527

2628
## Usage
2729

28-
After installation it is available in your shell as:
30+
Forget the times when you used `git commit -m "..."`, now just type:
2931
```sh
30-
$ semantic-git-commit
32+
$ sgc
3133
```
32-
or even shorter:
34+
or if you already have an alias for sgc, use following instead:
3335
```sh
34-
$ sgc
36+
$ semantic-git-commit
3537
```
3638

3739
## Config

0 commit comments

Comments
 (0)