Skip to content

Commit 0be5fe4

Browse files
committed
chore(readme): updated instructions at readme
1 parent e3f44ed commit 0be5fe4

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
@@ -31,9 +31,37 @@ Just follow the commands below:
3131

3232
## Usage and configuration
3333

34-
Configuration tags available:
34+
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:
35+
36+
```yaml
37+
convention: angular
38+
# or
39+
convention: changelog
40+
# or even
41+
convention: symphony
42+
```
43+
44+
45+
46+
Supported conventions available:
3547
<!-- list here all tags that are used in configuration file -->
36-
-
48+
49+
- angular/karma
50+
- changelog
51+
- symphony
52+
53+
In the event of no commiter.yml file presence, you will be prompted with the following option menu:
54+
55+
```bash
56+
No config files found!
57+
Running default script...
58+
what type of commit convention are you using?
59+
1- Karma/Angular
60+
2- Conventional changelog
61+
3- Symfony CMF
62+
```
63+
64+
3765

3866
## Project's maintainers
3967
| **Name** | **Username** |

0 commit comments

Comments
 (0)