Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 2e04204

Browse files
authoredSep 6, 2018
merge(#4): readme text
Readmereadme
2 parents f864e2e + 00ec51f commit 2e04204

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed
 

‎README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,31 @@
55
# Commit Helper
66
---
77
## What does it do?
8-
The commit-helper do exactly what it's name suggest: helps you create and maintain your commit policy by tailoring your commit message into a commit comvention.
8+
The commit-helper do exactly what it's name suggest: helps you create and maintain your commit policy by tailoring your commit message into a commit convention.
99

1010
## Why should I use this?
1111
Keeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.
1212

1313
Sometimes we, the devs, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?
1414

15+
## Instalation
16+
Just follow the commands below:
17+
18+
```bash
19+
20+
# if you don't have git, run $ sudo apt install git first
21+
22+
# clone the repo into your home
23+
$ git clone https://github.com/andre-filho/commit-helper.git ~/.commit-helper
24+
25+
# create a function in your .bashrc
26+
$ echo "commit(){ python3 ~/.commit-helper/generator.py; }" >> ~/.bashrc
27+
28+
# reload terminal
29+
$ source ~/.bashrc
30+
31+
```
32+
1533
## Project's maintainers
1634
| **Name** | **Username** |
1735
| :--------: | :-----: |

0 commit comments

Comments
 (0)
Please sign in to comment.