Skip to content

Commit 146c2e5

Browse files
committed
Update: Enhance README with detailed setup, usage, and sample output sections
Improve clarity and provide comprehensive guidance for users.
1 parent 965782f commit 146c2e5

File tree

2 files changed

+41
-5
lines changed

2 files changed

+41
-5
lines changed

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,54 @@
1+
12
# commit-msg
2-
## Add GROK_API_KEY to system variables
33

4+
![Commit-msg Screenshot](image.png)
5+
6+
## Add `GROK_API_KEY` to System Variables
7+
8+
Before running the application, ensure you have set the `GROK_API_KEY` as a system environment variable.
9+
10+
---
411

5-
## Setup
6-
```bash
12+
## Setup
13+
14+
To set up `commit-msg`, run the following command:
15+
16+
```bash
717
go run src/main.go --setup --path F:/Git/commit-msg --name commit-msg
818
```
919

20+
---
21+
1022
## Usage
1123

24+
To run `commit-msg`, use:
25+
1226
```bash
1327
go run src/main.go --path F:/Git/commit-msg
1428
```
15-
### this will run the commit-msg in the current directory
29+
30+
This will execute `commit-msg` in the current directory:
31+
1632
```bash
1733
go run src/main.go .
18-
```
34+
```
35+
36+
---
37+
38+
## Sample Output
39+
40+
Below is a sample execution of `commit-msg`:
41+
42+
```bash
43+
# Example output here (replace with actual example)
44+
```
45+
46+
---
47+
48+
## Screenshot
49+
50+
Here’s an image of the application in action:
51+
52+
53+
54+

image.png

26.7 KB
Loading

0 commit comments

Comments
 (0)