Skip to content

Commit 5ba9a93

Browse files
committed
docs: update readme with instructions and examples on use
1 parent b55d893 commit 5ba9a93

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,33 @@ zig build run
1717
```bash
1818
./zig-out/bin/zig-commit-emoji --help
1919
```
20+
21+
## Features
22+
23+
### List
24+
25+
#### What does it do ?
26+
27+
Will simply list all emojis available with their description.
28+
29+
#### How to use ?
30+
31+
```bash
32+
./zig-commit-emoji list
33+
```
34+
35+
### Search
36+
37+
#### What does it do ?
38+
39+
Will look for the keyword typed in all emojis descriptions.
40+
41+
#### How to use ?
42+
43+
```bash
44+
./zig-commit-emoji search -k <keyword>
45+
```
46+
47+
```bash
48+
./zig-commit-emoji search -k "feat"
49+
```

0 commit comments

Comments
 (0)