Skip to content

Commit 7eddb5d

Browse files
docs: update README with revised instructions and remove redundant usage section
- Updated the instructions for committing changes with git gpt commit. - Removed the redundant Usage section that duplicated information already covered in the setup instructions.
1 parent 8de61db commit 7eddb5d

File tree

1 file changed

+1
-21
lines changed

1 file changed

+1
-21
lines changed

README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ git gpt open-api-key
2222

2323
Select "Add or update API key" from the menu and enter your API key when prompted. Your key will be securely stored in your user configuration.
2424

25-
- **Step3:** commit your changes with AI
25+
- **Step3:** commit your changes with `git gpt commit`
2626

2727
```bash
2828
git add --all
@@ -31,26 +31,6 @@ git gpt commit // generate commit message with AI
3131

3232
✅ You've completed all setup!
3333

34-
## Usage
35-
36-
After setting up the project, you can use the Git extension in any Git repository:
37-
38-
### Generate Commit Message
39-
40-
Stage your changes:
41-
42-
```bash
43-
git add --all
44-
```
45-
46-
Generate a commit message:
47-
48-
```bash
49-
git gpt commit
50-
```
51-
52-
The extension will analyze your staged changes and generate a commit message using OpenAI's model. You'll be prompted to confirm the message before it's committed.
53-
5434
### Available Commands
5535

5636
- **Commit with AI-generated message**

0 commit comments

Comments
 (0)