Skip to content

Commit 65709ec

Browse files
committed
update readme
1 parent f1a3581 commit 65709ec

File tree

1 file changed

+36
-15
lines changed

1 file changed

+36
-15
lines changed

README.md

+36-15
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,40 @@
1-
# bubbletea-app-template
1+
# go-git-commands
22

3-
A template repository to create [Bubbletea][bubbletea] apps.
3+
## commit
44

5-
## Included
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`.
67

7-
- a sample app that does nothing, so it includes all dependencies:
8-
- [bubbletea][]
9-
- [bubbles][]
10-
- [lipgloss][]
11-
- github actions workflows for build, test, lint and release
12-
- [GoReleaser][goreleaser] configs
13-
- [golangci-lint][lint] configs
8+
### Install
149

15-
[bubbletea]: https://github.com/charmbracelet/bubbletea
16-
[bubbles]: https://github.com/charmbracelet/bubbles
17-
[lipgloss]: https://github.com/charmbracelet/lipgloss
18-
[goreleaser]: https://goreleaser.com
19-
[lint]: https://golangci-lint.run
10+
```bash
11+
brew install mrados7/main/commit
12+
# or
13+
go install github.com/mrados7/go-git-commands/commit@latest
14+
```
15+
16+
17+
### Usage
18+
19+
```bash
20+
commit
21+
```
22+
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`.
26+
27+
28+
### Install
29+
30+
```bash
31+
brew install mrados7/main/checkout
32+
# or
33+
go install github.com/mrados7/go-git-commands/checkout@latest
34+
```
35+
36+
### Usage
37+
38+
```bash
39+
checkout
40+
```

0 commit comments

Comments
 (0)