Skip to content

Commit c3147e5

Browse files
committed
chore(readme): updates readme
1 parent b08b10e commit c3147e5

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The commit-helper do exactly what it's name suggest: helps you create and mainta
99
## Why should I use this?
1010
Keeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.
1111

12-
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?
12+
Sometimes we, the developers, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?
1313

1414
## Installation
1515

@@ -40,11 +40,19 @@ Just follow the commands below:
4040
For this project to work smoothly, you must have in your working directory a file named **commiter.yml**. In this file you must pass the commit convention that you want to use, following the example:
4141

4242
```yaml
43-
convention: angular
43+
convention: angular # tag(context): commit message
44+
4445
# or
45-
convention: changelog
46-
# or even
47-
convention: symphony
46+
47+
convention: changelog # TAG: commit message
48+
49+
# or
50+
51+
convention: symphony # [Tag] commit message
52+
53+
# and if you're feeling adventurous
54+
55+
convention: none # Commit message
4856
```
4957
5058
@@ -62,9 +70,12 @@ In the event of no commiter.yml file presence, you will be prompted with the fol
6270
No config files found!
6371
Running default script...
6472
what type of commit convention are you using?
65-
1- Karma/Angular
66-
2- Conventional changelog
67-
3- Symfony CMF
73+
74+
(default): No convention
75+
1: Karma/Angular
76+
2: Conventional changelog
77+
3: Symfony CMF
78+
6879
```
6980

7081

0 commit comments

Comments
 (0)