Skip to content

Commit 7ca52b0

Browse files
committed
docs: refresh documentation for model support and clarity
- Add gpt-5 to the list of supported ChatGPT models in the description - Remove the feature item referencing the external model list - Streamline and standardize Chinese feature bullets for clarity, including capitalization tweaks, concise wording, and minor formatting fixes Signed-off-by: appleboy <[email protected]>
1 parent b6af6b1 commit 7ca52b0

File tree

3 files changed

+15
-20
lines changed

3 files changed

+15
-20
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![codecov](https://codecov.io/gh/appleboy/CodeGPT/branch/main/graph/badge.svg)](https://codecov.io/gh/appleboy/CodeGPT)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/CodeGPT)](https://goreportcard.com/report/github.com/appleboy/CodeGPT)
66

7-
A CLI tool written in [Go](https://go.dev) that generates git commit messages or provides code review summaries using ChatGPT AI (gpt-4o, gpt-4 model). It also automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
7+
A CLI tool written in [Go](https://go.dev) that generates git commit messages or provides code review summaries using ChatGPT AI (gpt-5, gpt-4o, gpt-4 model). It also automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
88

99
- [繁體中文介紹][1]
1010
- [繁體中文影片][2]
@@ -63,7 +63,6 @@ A CLI tool written in [Go](https://go.dev) that generates git commit messages or
6363
- Enables file exclusion patterns for git diff operations.
6464
- Translates commit messages into other languages (supports `en`, `zh-tw`, or `zh-cn`).
6565
- Supports SOCKS proxy or custom network HTTP proxy.
66-
- Provides a [model list](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) including `gpt-4`, `gpt-4o`, etc.
6766
- Generates brief code reviews.
6867
- Allows customization of prompt templates and variables.
6968

README.zh-cn.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,14 @@
5353
## 功能
5454

5555
- 支持 [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][Anthropic][100][Ollama][41][Groq][30][OpenRouter][50]
56-
- 支持 [conventional commits 规范](https://www.conventionalcommits.org/en/v1.0.0/)
57-
- 支持 Git prepare-commit-msg Hook,参见 [Git Hooks 文档](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
58-
- 支持通过指定上下文行数自定义差异生成(默认值:3)。
59-
- 支持 git diff 排除文件模式。
60-
- 支持将提交信息翻译成其他语言(支持 `en``zh-tw``zh-cn`)。
61-
- 支持 socks 代理或自定义网络 HTTP 代理。
62-
- 支持 [模型列表](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38),如 `gpt-4``gpt-4o` 等。
63-
- 支持生成简要的代码审查。
56+
- 遵循 [conventional commits 规范](https://www.conventionalcommits.org/en/v1.0.0/)
57+
- 集成 Git prepare-commit-msg Hook,详见 [Git Hooks 文档](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
58+
- 可通过指定上下文行数(默认值:3)自定义生成的差异内容。
59+
- 支持差异文件排除模式(git diff)。
60+
- 可将提交信息翻译为其他语言(支持 `en``zh-tw``zh-cn`)。
61+
- 支持 SOCKS 代理或自定义网络 HTTP 代理。
62+
- 生成简洁的代码审查摘要。
6463
- 支持自定义提示模板和变量。
65-
6664
![code review](./images/code_review.png)
6765

6866
## 安装

README.zh-tw.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,13 @@
5858

5959
- 支援 [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][Anthropic][100][Ollama][41][Groq][30][OpenRouter][50]
6060
- 遵循 [conventional commits 規範](https://www.conventionalcommits.org/en/v1.0.0/)
61-
- 與 Git prepare-commit-msg Hook 集成,請參閱 [Git Hooks 文檔](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
62-
- 允許透過指定上下文行數來自定義差異生成(預設值:3)。
63-
- 支援 git diff 排除檔案模式。
64-
- 將提交訊息翻譯成其他語言(支援 `en``zh-tw``zh-cn`)。
65-
- 支援 SOCKS 代理或自定義網絡 HTTP 代理。
66-
- 提供 [模型列表](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38),包括 `gpt-4``gpt-4o` 等。
67-
- 生成簡短的代碼審查。
68-
- 允許自定義提示模板和變量。
69-
61+
- 整合 Git prepare-commit-msg Hook,詳情請參閱 [Git Hooks 文件](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
62+
- 可透過指定上下文行數(預設:3)來自訂產生的差異內容。
63+
- 支援差異檔案排除模式(git diff)。
64+
- 將提交訊息翻譯為其他語言(支援 `en``zh-tw``zh-cn`)。
65+
- 支援 SOCKS 代理或自訂 HTTP 網路代理。
66+
- 生成簡潔的程式碼審查摘要。
67+
- 允許自訂提示模板及變數。
7068
![code review](./images/code_review.png)
7169

7270
## 安裝

0 commit comments

Comments
 (0)