Skip to content

Commit 7b77e2a

Browse files
authored
Update README.md
1 parent 79d8711 commit 7b77e2a

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ commitly --preview
2525
To configure the `.gitconfig` file with the API key, add the following section to your `.gitconfig` file:
2626

2727
```ini
28-
[aiCommit]
28+
[commitly]
2929
apiKey = YOUR_API_KEY_HERE
3030
```
3131

@@ -44,10 +44,20 @@ Replace `YOUR_API_KEY_HERE` with your actual API key.
4444
Here are some examples of how to use the `commitly` command:
4545

4646
```sh
47-
# Generate a commit message using the AI service
47+
# Generate a commit using the AI service
4848
commitly
4949
```
5050

51+
```sh
52+
# Preview a commit using the AI service, then commit it
53+
commitly --preview
54+
```
55+
56+
```sh
57+
# Generate maximum 2 commits using the AI service
58+
commitly --max 2
59+
```
60+
5161
## Config Command
5262

5363
To read the current configuration, use the `config` command:

0 commit comments

Comments
 (0)