Skip to content

Commit 62228ba

Browse files
committed
docs: improve documentation clarity and grammar
- Correct grammatical errors and improve clarity in the project description - Change "Feature" section header to "Features" - Correct grammatical errors and improve clarity in the "Features" list - Correct "MacOS" to "macOS" - Correct grammatical errors in instructions for storing API keys and obtaining API keys from Groq API Service Signed-off-by: appleboy <[email protected]>
1 parent cc758ac commit 62228ba

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
![cover](./images/cover.png)
88

9-
A CLI written in [Go](https://go.dev) language that writes git commit messages or do a code review brief for you using ChatGPT AI (gpt-3.5-turbo, gpt-4 model) and automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
9+
A CLI written in [Go](https://go.dev) that writes git commit messages or provides a code review summary for you using ChatGPT AI (gpt-3.5-turbo, gpt-4 model) and automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
1010

1111
* [繁體中文介紹][1]
1212
* [繁體中文影片][2]
@@ -16,23 +16,23 @@ A CLI written in [Go](https://go.dev) language that writes git commit messages o
1616

1717
![flow](./images/flow.svg)
1818

19-
## Feature
19+
## Features
2020

21-
* Support [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30] and [OpenRouter][50].
22-
* Support [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
23-
* Support Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
24-
* Support customize generate diffs with n lines of context, the default is three.
25-
* Support for excluding files from the git diff command.
26-
* Support commit message translation into another language (support `en`, `zh-tw` or `zh-cn`).
27-
* Support socks proxy or custom network HTTP proxy.
28-
* Support [model lists](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) like `gpt-4`, `gpt-3.5-turbo` ...etc.
29-
* Support do a brief code review.
21+
* Supports [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Ollama][41], [Groq][30], and [OpenRouter][50].
22+
* Supports [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
23+
* Supports Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
24+
* Supports customizing generated diffs with n lines of context, the default is three.
25+
* Supports excluding files from the git diff command.
26+
* Supports commit message translation into another language (supports `en`, `zh-tw`, or `zh-cn`).
27+
* Supports socks proxy or custom network HTTP proxy.
28+
* Supports [model lists](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) like `gpt-4`, `gpt-3.5-turbo`, etc.
29+
* Supports generating a brief code review.
3030

3131
![code review](./images/code_review.png)
3232

3333
## Installation
3434

35-
Install from [Homebrew](http://brew.sh/) on MacOS
35+
Install from [Homebrew](http://brew.sh/) on macOS
3636

3737
```sh
3838
brew tap appleboy/tap
@@ -45,7 +45,7 @@ Install from [Chocolatey](https://chocolatey.org/install) on Windows
4545
choco install codegpt
4646
```
4747

48-
The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/CodeGPT/releases).Change the binary permissions to `755` and copy the binary to the system bin directory. Use the `codegpt` command as shown below.
48+
The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/CodeGPT/releases). Change the binary permissions to `755` and copy the binary to the system bin directory. Use the `codegpt` command as shown below.
4949

5050
```sh
5151
$ codegpt version
@@ -64,15 +64,15 @@ Please first create your OpenAI API Key. The [OpenAI Platform](https://platform.
6464

6565
![register](./images/register.png)
6666

67-
An environment variable is a variable that is set on your operating system, rather than within your application. It consists of a name and value.We recommend that you set the name of the variable to `OPENAI_API_KEY`.
67+
An environment variable is a variable that is set on your operating system, rather than within your application. It consists of a name and value. We recommend that you set the name of the variable to `OPENAI_API_KEY`.
6868

6969
See the [Best Practices for API Key Safety](https://help.openai.com/en/articles/5112595-best-practices-for-api-key-safety).
7070

7171
```sh
7272
export OPENAI_API_KEY=sk-xxxxxxx
7373
```
7474

75-
or store your API key in custom config file.
75+
or store your API key in a custom config file.
7676

7777
```sh
7878
codegpt config set openai.api_key sk-xxxxxxx
@@ -130,7 +130,7 @@ codegpt config set openai.model gemini-1.5-flash-latest
130130

131131
### How to change to [Groq][30] API Service
132132

133-
Please get the `API key` from Groq API Service, please vist [here][31]. Update the `base_url` and `api_key` in your config file.
133+
Please get the `API key` from Groq API Service, please visit [here][31]. Update the `base_url` and `api_key` in your config file.
134134

135135
```sh
136136
codegpt config set openai.provider openai

0 commit comments

Comments
 (0)