Skip to content

Commit f423b41

Browse files
author
Russian Reboucas
committed
docs: improve README
1 parent 4f30de2 commit f423b41

File tree

1 file changed

+22
-35
lines changed

1 file changed

+22
-35
lines changed

README.md

Lines changed: 22 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,33 @@
11
## Installation:
22

33
1. Clone this repo, prefferably in your $HOME directory.
4-
``` git clone https://github.com/russian60/git-semantic-commits ~/.git-semantic-commits ```
4+
``` git clone https://github.com/russiann/git-semantic-commits ~/.git-semantic-commits ```
55

66
2. Add the folder to your $PATH.
77
* if using Bash, open ```~/.bashrc``` with your favourite editor and add this line: <br/> ``` export PATH=$PATH:$HOME/.git-semantic-commits:$PATH ```
88
* if using Zsh, open ```~/.zshrc``` with your favourite editor and add this line: <br/> ``` export PATH=$PATH:$HOME/.git-semantic-commits:$PATH ```
99

1010
3. Save the file and source the changes in bashrc/zshrc: ```source ~/.bashrc``` or ```source ~/.zshrc```
11-
4. Done! grin emoticon
1211

13-
Commands:
12+
4. Done!
1413

15-
* ```git feat "commit-message-here"```
16-
* ---> ```git commit -m 'feat: commit-message-here'```
17-
* ```git feat "component-name" "commit-message-here"```
18-
* ---> ```git commit -m 'feat(component-name): commit-message-here'```
19-
* ```git docs "commit-message-here"```
20-
* ---> ```git commit -m 'docs: commit-message-here'```
21-
* ```git docs "component-name" "commit-message-here"```
22-
* ---> ```git commit -m 'docs(component-name): commit-message-here'```
23-
* ```git chore "commit-message-here"```
24-
* ---> ```git commit -m 'chore: commit-message-here'```
25-
* ```git chore "component-name" "commit-message-here"```
26-
* ---> ```git commit -m 'chore(component-name): commit-message-here'```
27-
* ```git fix "commit-message-here"```
28-
* ---> ```git commit -m 'fix: commit-message-here'```
29-
* ```git fix "component-name" "commit-message-here"```
30-
* ---> ```git commit -m 'fix(component-name): commit-message-here'```
31-
* ```git refactor "commit-message-here"```
32-
* ---> ```git commit -m 'refactor: commit-message-here'```
33-
* ```git refactor "component-name" "commit-message-here"```
34-
* ---> ```git commit -m 'refactor(component-name): commit-message-here'```
35-
* ```git style "commit-message-here"```
36-
* ---> ```git commit -m 'style: commit-message-here'```
37-
* ```git style "component-name" "commit-message-here"```
38-
* ---> ```git commit -m 'style(component-name): commit-message-here'```
39-
* ```git test "commit-message-here"```
40-
* ---> ```git commit -m 'test: commit-message-here'```
41-
* ```git test "component-name" "commit-message-here"```
42-
* ---> ```git commit -m 'test(component-name): commit-message-here'```
43-
* ```git localize "commit-message-here"```
44-
* ---> ```git commit -m 'localize: commit-message-here'```
45-
* ```git localize "component-name" "commit-message-here"```
46-
* ---> ```git commit -m 'localize(component-name): commit-message-here'```
14+
### Commands:
15+
16+
| Command | Return |
17+
| --------------------- | ------------------------------- |
18+
| `git feat <message>` | feat: message |
19+
| `git feat <scope> <message>` | feat(scope): message |
20+
| `git docs <message>` | docs: message |
21+
| `git docs <scope> <message>` | docs(scope): message |
22+
| `git chore <message>` | chore: message |
23+
| `git chore <scope> <message>` | chore(scope): message |
24+
| `git fix <message>` | fix: message |
25+
| `git fix <scope> <message>` | fix(scope): message |
26+
| `git refactor <message>` | refactor: message |
27+
| `git refactor <scope> <message>` | refactor(scope): message |
28+
| `git style <message>` | style: message |
29+
| `git style <scope> <message>` | style(scope): message |
30+
| `git test <message>` | test: message |
31+
| `git test <scope> <message>` | test(scope): message |
32+
| `git localize <message>` | localize: message |
33+
| `git localize <scope> <message>` | localize(scope): message |

0 commit comments

Comments
 (0)