Skip to content

Commit d2811e1

Browse files
committed
update readme
1 parent 915717c commit d2811e1

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,25 @@
88

99
This is a parser for [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
1010

11+
```bash
12+
go get -u github.com/release-lab/conventional-commit-parser
13+
```
14+
15+
```go
16+
package main
17+
18+
import (
19+
"fmt"
20+
"release-lab/conventional-commit-parser"
21+
)
22+
23+
func main() {
24+
result := conventionalcommitparser.Parse("feat: this is a commit message")
25+
26+
fmt.Printf("%+v\n", result)
27+
}
28+
```
29+
1130
### License
1231

1332
The [Anti-996 License](LICENSE)

0 commit comments

Comments
 (0)