Skip to content

Commit c33bdc7

Browse files
author
R0n0066
committed
feature (add): Add getting started to readme
1 parent 94e99a4 commit c33bdc7

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

Readme.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
1-
# CMF Commit Message FORMATTER
1+
# CMF Commit Message Formatter
22

3-
---
3+
CMF is a simple to use utility to standarize commit messages on projects.
44

5-
CMF is an utility to standarize commit messages on porjects.
5+
## Getting started
6+
7+
Install via npm, just do `$ npm install -g go-cmf`
8+
9+
Once installed, go to your project an run `$ cmf` after add your files to your stage area.
10+
11+
## Flows
12+
13+
CMF have two flows (for now) default and jira
14+
15+
### Default
16+
17+
Running `$ cmf` you get the default flow, you will be prompt for:
18+
19+
- Type of change you made to your code
20+
- Module affected by this change
21+
- Commit message or description of your change
22+
23+
### Jira
24+
25+
Running `$ cmf jira` you get jira flow, this time you will be prompt for:
26+
27+
- Jira task ID
28+
- Type of change you made to your code
29+
- Commit message or description of your change

0 commit comments

Comments
 (0)