Skip to content

Commit f07ab86

Browse files
committed
chore(release): create dev release v0.1.0
1 parent 47d2d7c commit f07ab86

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
<details>
2424
<summary>Install</summary>
2525

26+
- [Go get](#go-get)
2627
- [Homebrew](#homebrew)
2728

2829
</details>
@@ -38,22 +39,60 @@
3839
<summary>Configuration</summary>
3940

4041
- [Conventional commits](#conventional-commits)
42+
- [Conventional changelog](#conventional-changelog)
4143

4244
</details>
4345

4446
## Overview
4547

4648
## Install
4749

50+
### Go get
51+
If you have `Go` setup on your machine, get and install by:
52+
```
53+
$ go get github.com/Roytangrb/gitwok@v0.1.0
54+
```
55+
`gitwok` executable should be available if `$GOPATH/bin` is already in your `PATH`, otherwise put the binary in one of your `PATH` directories
56+
4857
### Homebrew
4958

59+
> coming soon
60+
5061
## Usage
5162

5263
### `commit` command
5364

65+
#### `flags` mode
66+
The `gitwok commit` command is used for building the commit message following [conventional commit v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) specification, follow by executing `git commit -m <msg>`.
67+
68+
You can build the commit message using flags for subcommand `commit`, example:
69+
```
70+
$ gitwok commit -t docs -s readme.md -d "update documentation"
71+
```
72+
which commits with a simple and valid message:
73+
```
74+
$ docs(readme.md): update documentation
75+
```
76+
You can check all flags by `gitwok commit --help`
77+
78+
#### `interactive` mode
79+
You may also build the commit message using interactively by running
80+
```
81+
$ gitwok commit
82+
````
83+
with no flag or argument. You will be prompted for selecting/entering each conventional commit message component.
84+
85+
> coming soon
86+
5487
## Configuration
5588
5689
### Conventional commits
5790
91+
> coming soon
92+
93+
### Conventional changelog
94+
95+
> coming soon
96+
5897
## Reference
5998
* [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/)

cmd/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ var logger *util.Logger = util.InitLogger(os.Stdout, os.Stdout, os.Stdout, os.St
2020
// rootCmd represents the base command when called without any subcommands
2121
var rootCmd = &cobra.Command{
2222
Use: "gitwok",
23-
Version: "v0.0.0",
23+
Version: "v0.1.0",
2424
Short: "Configurable CLI with conventional commits, changelog, git hooks all in one",
2525
Run: func(cmd *cobra.Command, args []string) {},
2626
}

0 commit comments

Comments
 (0)