Skip to content

Commit

Permalink
Docs: improved why
Browse files Browse the repository at this point in the history
  • Loading branch information
JPeer264 committed May 6, 2017
1 parent 55a7dac commit fc739da
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@

## Why?

Many projects got different git commit rules. It is hard to remember them all.
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.

`sgc` will take care of the commit guidelines, so you can focus on the more important stuff: **code**

## Installation

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

## Usage

After installation it is available in your shell as:
Forget the times when you used `git commit -m "..."`, now just type:
```sh
$ semantic-git-commit
$ sgc
```
or even shorter:
or if you already have an alias for sgc, use following instead:
```sh
$ sgc
$ semantic-git-commit
```

## Config
Expand Down

0 comments on commit fc739da

Please sign in to comment.