Skip to content

Commit ec5aa4b

Browse files
committed
update git version requirement in readme
1 parent ed931e6 commit ec5aa4b

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

README-en.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ This project is a review assistant, not a substitute for tests, security analysi
2525
## Requirements
2626

2727
- Go 1.25.12 or later when building from source
28-
- Git and a Git repository to review
29-
- credentials for one supported model provider (not needed for `--preview`)
28+
- Git 2.38.0 or later and a Git repository to review
29+
- credentials for a supported LLM service (not needed for `--preview`)
3030

3131
## Installation
3232

@@ -36,7 +36,7 @@ This project is a review assistant, not a substitute for tests, security analysi
3636
go install github.com/koderover/zadig-review-agent@latest
3737
```
3838

39-
`go install` honors the standard `GOPROXY` setting. To use a trusted proxy for one installation:
39+
`go install` supports the standard `GOPROXY` setting:
4040

4141
```bash
4242
GOPROXY=https://goproxy.cn,direct \
@@ -58,13 +58,13 @@ make build
5858

5959
## Quick start
6060

61-
Preview which files and rules would be used without contacting a model:
61+
You can preview file filtering and rule resolution without contacting a model:
6262

6363
```bash
6464
zadig-review-agent review --preview
6565
```
6666

67-
Configure a provider. Keeping the API key in an environment variable avoids writing it to disk or shell history:
67+
Configure the model. We recommend providing the API key through an environment variable to avoid writing it to disk or shell history:
6868

6969
```bash
7070
zadig-review-agent config set model.protocol openai
@@ -170,7 +170,7 @@ Please report vulnerabilities according to [SECURITY.md](SECURITY.md), not throu
170170

171171
### Model is not configured
172172

173-
Set `model.name` and the provider settings, or export the corresponding `ZADIG_REVIEW_MODEL_*` variables. `--preview` works without model credentials.
173+
Set `model.name` and the model service settings, or export the corresponding `ZADIG_REVIEW_MODEL_*` variables. `--preview` works without model credentials.
174174

175175
### A range review cannot resolve its base
176176

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Zadig Review Agent 读取 Git 变更,使用用户配置的大语言模型识
2525
## 环境要求
2626

2727
- 从源码构建时需要 Go 1.25.12 或更高版本
28-
- Git 以及一个待审查的 Git 仓库
28+
- Git 2.38.0 或更高版本,以及一个待审查的 Git 仓库
2929
- 一个支持的 LLM 服务的凭证(`--preview` 不需要)
3030

3131
## 安装
@@ -58,7 +58,7 @@ make build
5858

5959
## 快速开始
6060

61-
先在不访问模型的情况下预览文件过滤与规则解析结果
61+
不访问模型的情况下可以预览文件过滤与规则解析结果
6262

6363
```bash
6464
zadig-review-agent review --preview

0 commit comments

Comments
 (0)