Skip to content

Commit b80993c

Browse files
littleCarelesslittleCareless
committed
📝 docs(readme): 优化 README 文件，添加命令列表和配置说明
1 parent 9ebfc88 commit b80993c

File tree

2 files changed

+28
-24
lines changed

2 files changed

+28
-24
lines changed

‎README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,10 @@ Supports 19 languages including:
108108

109109
### Commands
110110

111-
- `Generate Commit Message`: Generate commit message based on current changes
112-
- `Select AI Model`: Choose the AI model to use
113-
- `Generate Weekly Report`: Generate a weekly summary report of your work
111+
| Command ID | Category | Title | Description |
112+
|------------|----------|--------|-------------|
113+
| dish-ai-commit.selectModel | [Dish AI Commit] | Select AI Model for Commit Generation | Choose the AI model for generating commit messages |
114+
| dish-ai-commit.generateWeeklyReport | [Dish AI Commit] | Generate Weekly Report | Generate AI-powered weekly work report |
114115

115116
## Configuration Instructions
116117

@@ -249,3 +250,4 @@ This project is [MIT](./LICENSE) licensed.
249250
[total-installs-shield]: https://img.shields.io/vscode-marketplace/d/littleCareless.dish-ai-commit.svg?&color=greeen&labelColor=black&style=flat-square
250251
[avarage-rating-link]: https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
251252
[avarage-rating-shield]: https://img.shields.io/vscode-marketplace/r/littleCareless.dish-ai-commit.svg?&color=green&labelColor=black&style=flat-square
253+
````

‎README.zh-CN.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -74,30 +74,32 @@
7474

7575
### 配置项
7676

77-
| 配置项 | 类型 | 默认值 | 说明 |
78-
|---------------------------------------------------|----------|---------------------------|--------------------------------------------------------------|
79-
| dish-ai-commit.base.language | string | Simplified Chinese | 提交信息语言 |
80-
| dish-ai-commit.base.systemPrompt | string | "" | 自定义系统提示 |
81-
| dish-ai-commit.base.provider | string | OpenAI | AI 服务提供商 |
82-
| dish-ai-commit.base.model | string | gpt-3.5-turbo | AI 模型选择 |
83-
| dish-ai-commit.providers.openai.apiKey | string | "" | OpenAI API 密钥 |
84-
| dish-ai-commit.providers.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API 基础 URL |
85-
| dish-ai-commit.providers.zhipu.apiKey | string | "" | 智谱 AI API 密钥 |
86-
| dish-ai-commit.providers.dashscope.apiKey | string | "" | DashScope API 密钥 |
87-
| dish-ai-commit.providers.doubao.apiKey | string | "" | 豆包 API 密钥 |
88-
| dish-ai-commit.providers.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
89-
| dish-ai-commit.providers.gemini.apiKey | string | "" | Gemini AI API 密钥 |
90-
| dish-ai-commit.features.codeAnalysis.simplifyDiff | boolean | false | 启用 diff 内容简化功能 |
91-
| dish-ai-commit.features.codeAnalysis.maxLineLength | number | 120 | 简化后每行的最大长度 |
92-
| dish-ai-commit.features.codeAnalysis.contextLines | number | 3 | 保留的上下文行数 |
93-
| dish-ai-commit.features.commitFormat.enableMergeCommit | boolean | false | 是否允许将多个文件的变更合并为一条提交信息 |
94-
| dish-ai-commit.features.commitFormat.enableEmoji | boolean | true | 在提交信息中使用 emoji |
95-
| dish-ai-commit.features.weeklyReport.systemPrompt | string | "" | 周报生成的自定义系统提示 |
77+
| 配置项 | 类型 | 默认值 | 说明 |
78+
| ------------------------------------------------------ | ------- | ------------------------- | ------------------------------------------ |
79+
| dish-ai-commit.base.language | string | Simplified Chinese | 提交信息语言 |
80+
| dish-ai-commit.base.systemPrompt | string | "" | 自定义系统提示 |
81+
| dish-ai-commit.base.provider | string | OpenAI | AI 服务提供商 |
82+
| dish-ai-commit.base.model | string | gpt-3.5-turbo | AI 模型选择 |
83+
| dish-ai-commit.providers.openai.apiKey | string | "" | OpenAI API 密钥 |
84+
| dish-ai-commit.providers.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API 基础 URL |
85+
| dish-ai-commit.providers.zhipu.apiKey | string | "" | 智谱 AI API 密钥 |
86+
| dish-ai-commit.providers.dashscope.apiKey | string | "" | DashScope API 密钥 |
87+
| dish-ai-commit.providers.doubao.apiKey | string | "" | 豆包 API 密钥 |
88+
| dish-ai-commit.providers.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
89+
| dish-ai-commit.providers.gemini.apiKey | string | "" | Gemini AI API 密钥 |
90+
| dish-ai-commit.features.codeAnalysis.simplifyDiff | boolean | false | 启用 diff 内容简化功能 |
91+
| dish-ai-commit.features.codeAnalysis.maxLineLength | number | 120 | 简化后每行的最大长度 |
92+
| dish-ai-commit.features.codeAnalysis.contextLines | number | 3 | 保留的上下文行数 |
93+
| dish-ai-commit.features.commitFormat.enableMergeCommit | boolean | false | 是否允许将多个文件的变更合并为一条提交信息 |
94+
| dish-ai-commit.features.commitFormat.enableEmoji | boolean | true | 在提交信息中使用 emoji |
95+
| dish-ai-commit.features.weeklyReport.systemPrompt | string | "" | 周报生成的自定义系统提示 |
9696

9797
### 命令
9898

99-
- `Generate Commit Message`: 根据当前更改生成提交信息
100-
- `Select AI Model`: 选择要使用的 AI 模型
99+
| 命令 ID | 分类 | 标题 | 描述 |
100+
| ---------------------------------- | ---------------- | -------------------------- | ------------------------------ |
101+
| dish-ai-commit.selectModel | [Dish AI Commit] | 选择用于提交生成的 AI 模型 | 选择用于生成提交消息的 AI 模型 |
102+
| dish-ai-commit.generateWeekly 报告 | [Dish AI Commit] | 生成每周报告 | 基于过去的Commit生成 AI 驱动的每周工作报告 |
101103

102104
## 配置说明
103105

0 commit comments

Comments
 (0)