Skip to content

Commit 32d9176

Browse files
authored
📝 Update README.md
1 parent d9a39ab commit 32d9176

File tree

1 file changed

+4
-49
lines changed

1 file changed

+4
-49
lines changed

README.md

Lines changed: 4 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
- Generate the files `gitmojis.json` and `gitmojis.yml` with the semver field added.
55
- You can easily change the configuration of semver in [./semver.yml](./semver.yml) .
66

7-
# Usage
87
## Prepare
98
require `curl`, `jq`, `yq` and `node` command.
109

@@ -25,56 +24,12 @@ v13.14.0
2524
git clone https://github.com/nkmr-jp/gitmoji-semver
2625
```
2726

28-
## Generate
27+
## Usage
2928
```sh
30-
$ cd ./gitmoi-semver
31-
$ make gen GITMOJI_VERSION=v3.0.0
32-
```
33-
34-
## Check the generated files
35-
```sh
36-
$ cat build/dist/gitmojis.json | jq '.gitmojis[] | select(.name=="sparkles")'
37-
{
38-
"emoji": "",
39-
"entity": "✨",
40-
"code": ":sparkles:",
41-
"description": "Introduce new features.",
42-
"name": "sparkles",
43-
"semver": "minor"
44-
}
45-
46-
$ cat build/dist/gitmojis.yml | yq '.gitmojis[] | select(.name=="sparkles")'
47-
{
48-
"emoji": "",
49-
"entity": "✨",
50-
"code": ":sparkles:",
51-
"description": "Introduce new features.",
52-
"name": "sparkles",
53-
"semver": "minor"
54-
}
55-
```
56-
57-
## Show List
58-
```sh
59-
$ make list
60-
# Major (Breaking)
61-
{"emoji":"💥","code":":boom:","desc":"Introduce breaking changes."}
62-
63-
# Minor (Feature)
64-
{"emoji":"","code":":sparkles:","desc":"Introduce new features."}
65-
66-
# Patch (Fix)
67-
{"emoji":"🐛","code":":bug:","desc":"Fix a bug."}
68-
{"emoji":"🚑","code":":ambulance:","desc":"Critical hotfix."}
69-
70-
# None
71-
{"emoji":"🎨","code":":art:","desc":"Improve structure / format of the code."}
72-
{"emoji":"⚡️","code":":zap:","desc":"Improve performance."}
73-
{"emoji":"🔥","code":":fire:","desc":"Remove code or files."}
74-
{"emoji":"📝","code":":memo:","desc":"Add or update documentation."}
75-
{"emoji":"🚀","code":":rocket:","desc":"Deploy stuff."}
76-
...
29+
cd ./gitmoji-semver
30+
make help
7731
```
32+
![image](https://user-images.githubusercontent.com/8490118/97711943-179cc780-1b01-11eb-935f-951956cfb18c.png)
7833

7934
## Edit semver.yml for your project
8035

0 commit comments

Comments
 (0)