Skip to content

Commit 6a8cc5b

Browse files
committed
update readme
1 parent 65709ec commit 6a8cc5b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
# go-git-commands
22

3-
## commit
3+
## checkout
4+
Creates a new branch from the current branch using naming strategy `<type>/<ticket-id>/<branch-name>`.
5+
Supported types are `FEAT`, `FIX`, `IMPR`, `OPS`.
46

5-
Uses branch name to detrmine the commit message.
6-
If the branch name is `FIX/FE-1234/branch-name` then the commit message will be `[FIX] [FE-1234] commit-message`.
77

88
### Install
99

1010
```bash
11-
brew install mrados7/main/commit
11+
brew install mrados7/main/checkout
1212
# or
13-
go install github.com/mrados7/go-git-commands/commit@latest
13+
go install github.com/mrados7/go-git-commands/checkout@latest
1414
```
1515

16-
1716
### Usage
1817

1918
```bash
20-
commit
19+
checkout
2120
```
2221

23-
## checkout
24-
Creates a new branch from the current branch using naming strategy `<type>/<ticket-id>/<branch-name>`.
25-
Supported types are `FEAT`, `FIX`, `IMPR`, `OPS`.
22+
## commit
2623

24+
Uses branch name to detrmine the commit message.
25+
If the branch name is `FIX/FE-1234/branch-name` then the commit message will be `[FIX] [FE-1234] commit-message`.
2726

2827
### Install
2928

3029
```bash
31-
brew install mrados7/main/checkout
30+
brew install mrados7/main/commit
3231
# or
33-
go install github.com/mrados7/go-git-commands/checkout@latest
32+
go install github.com/mrados7/go-git-commands/commit@latest
3433
```
3534

35+
3636
### Usage
3737

3838
```bash
39-
checkout
39+
commit
4040
```

0 commit comments

Comments
 (0)