Skip to content

Commit 62d69c4

Browse files
committed
update doc
1 parent a4d7401 commit 62d69c4

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@
66
77
[![CI](https://github.com/emacs-openai/codegpt/actions/workflows/test.yml/badge.svg)](https://github.com/emacs-openai/codegpt/actions/workflows/test.yml)
88

9+
## 🔨 Usage
10+
11+
The fastest way to use this package:
12+
13+
```
14+
M-x codegpt
15+
```
16+
17+
List of supported commands,
18+
19+
| Commad | Description |
20+
|-------------------|-------------------------------------------------|
21+
| `codegpt` | The master command |
22+
| `codegpt-custom` | Write your own instruction |
23+
| `codegpt-doc` | Automatically write documentation for your code |
24+
| `codegpt-fix` | Find problems with it |
25+
| `codegpt-explain` | Explain the selected code |
26+
| `codegpt-improve` | Improve, refactor or optimize it |
27+
928
## Contribute
1029

1130
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

0 commit comments

Comments
 (0)