Skip to content

Commit 002ce53

Browse files
author
V2RaySSR综合网
committed
优化Release说明和README使用方法
主要改进: 1. 修复构建时间显示错误,使用正确的GitHub Actions变量 2. 简化Release说明,移除不必要的下载说明和校验文件 3. 更新README使用方法,添加RealiTLScanner扫描命令 4. 移除checksums.txt生成,简化构建流程 5. 在Release中引用README.md获取详细使用方法 技术改进: - 添加build_time步骤获取正确的构建时间 - 优化Release说明结构,更加简洁明了 - 完善工作流程说明,包含具体的扫描命令参数
1 parent 0b9438c commit 002ce53

File tree

3 files changed

+41
-58
lines changed

3 files changed

+41
-58
lines changed

.github/workflows/build.yml

Lines changed: 25 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ jobs:
3434
echo "version=$VERSION" >> $GITHUB_OUTPUT
3535
echo "Building version: $VERSION"
3636
37+
- name: Get build time
38+
id: build_time
39+
run: |
40+
BUILD_TIME=$(date -u +"%Y-%m-%d %H:%M:%S UTC")
41+
echo "time=$BUILD_TIME" >> $GITHUB_OUTPUT
42+
3743
- name: Build for multiple platforms
3844
run: |
3945
# 创建输出目录
@@ -84,11 +90,6 @@ jobs:
8490
# 显示构建结果
8591
ls -la dist/
8692
87-
- name: Create checksums
88-
run: |
89-
cd dist
90-
sha256sum * > checksums.txt
91-
9293
- name: Create Release
9394
if: startsWith(github.ref, 'refs/tags/')
9495
uses: softprops/action-gh-release@v1
@@ -98,55 +99,36 @@ jobs:
9899
body: |
99100
## Reality协议目标网站检测工具 ${{ steps.version.outputs.version }}
100101
101-
### 下载说明
102-
103-
请根据您的操作系统和架构选择对应的zip文件:
102+
### 使用方法
104103
105-
**Linux:**
106-
- `reality-checker-linux-amd64.zip` - Linux x86_64
107-
- `reality-checker-linux-arm64.zip` - Linux ARM64
104+
详细使用方法请参考 [README.md](https://github.com/V2RaySSR/RealityChecker/blob/main/README.md)
108105
109-
**Windows:**
110-
- `reality-checker-windows-amd64.zip` - Windows x86_64
111-
- `reality-checker-windows-arm64.zip` - Windows ARM64
106+
**基本命令:**
107+
```bash
108+
# 单域名检测
109+
./reality-checker check example.com
112110
113-
**macOS:**
114-
- `reality-checker-macos-amd64.zip` - macOS Intel
115-
- `reality-checker-macos-arm64.zip` - macOS Apple Silicon
111+
# 批量检测
112+
./reality-checker batch "domain1,domain2,domain3"
116113
117-
### 使用方法
114+
# CSV文件检测
115+
./reality-checker csv domains.csv
116+
```
118117
119-
1. 下载对应您系统的zip文件
120-
2. 解压zip文件
121-
3. 解压后得到 `reality-checker`(Linux/macOS)或 `reality-checker.exe`(Windows)
122-
4. 运行程序:
118+
**推荐工作流程:**
119+
1. 使用 [RealiTLScanner](https://github.com/XTLS/RealiTLScanner) 扫描VPS IP:
123120
```bash
124-
# Linux/macOS
125-
./reality-checker check example.com
126-
127-
# Windows
128-
reality-checker.exe check example.com
121+
./RealiTLScanner -addr <VPS IP> -port 443 -thread 50 -timeout 5 -out file.csv
122+
```
123+
2. 使用本工具检测生成的CSV文件:
124+
```bash
125+
./reality-checker csv file.csv
129126
```
130-
131-
### 校验文件
132-
133-
下载后请验证文件完整性:
134-
```bash
135-
sha256sum -c checksums.txt
136-
```
137-
138-
### 自动数据文件下载
139-
140-
程序首次运行时会自动下载必要的数据文件,包括:
141-
- GeoIP数据库 (Country.mmdb)
142-
- GFW规则列表 (gfwlist.conf)
143-
- CDN检测关键词 (cdn_keywords.txt)
144-
- 热门网站列表 (hot_websites.txt)
145127
146128
### 版本信息
147129
- **版本**: ${{ steps.version.outputs.version }}
148130
- **提交**: ${{ github.sha }}
149-
- **构建时间**: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
131+
- **构建时间**: ${{ steps.build_time.outputs.time }}
150132
151133
---
152134

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,22 +70,35 @@ go build -o reality-checker
7070
./reality-checker batch "apple.com,tesla.com,microsoft.com"
7171
```
7272

73-
**推荐工作流程**: 对于大量域名检测,建议先使用 [RealiTLScanner](https://github.com/XTLS/RealiTLScanner) 进行初步扫描,生成 `domains.csv` 文件,然后使用本工具进行深度检测。
74-
7573
### CSV文件检测
7674

7775
```bash
7876
# 从CSV文件批量检测域名
7977
./reality-checker csv domains.csv
8078
```
8179

82-
**注意**: 对于多域名检测,建议配合使用 [RealiTLScanner](https://github.com/XTLS/RealiTLScanner) 工具。该工具可以扫描大量域名并生成 `domains.csv` 文件,然后使用本工具进行详细的Reality协议适合性检测。
80+
### 推荐工作流程
81+
82+
对于大量域名检测,建议配合使用 [RealiTLScanner](https://github.com/XTLS/RealiTLScanner) 工具:
83+
84+
**1. 使用RealiTLScanner扫描VPS IP:**
85+
```bash
86+
./RealiTLScanner -addr <VPS IP> -port 443 -thread 50 -timeout 5 -out file.csv
87+
```
88+
89+
**2. 使用本工具检测生成的CSV文件:**
90+
```bash
91+
./reality-checker csv file.csv
92+
```
8393

8494
### 查看帮助
8595

8696
```bash
8797
# 显示使用说明
8898
./reality-checker
99+
100+
# 查看版本信息
101+
./reality-checker version
89102
```
90103

91104
## ⚡ 性能特性

main.go

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,6 @@ import (
88
"RealityChecker/internal/data"
99
)
1010

11-
// 版本信息,由构建时注入
12-
var (
13-
Version = "dev"
14-
Commit = "unknown"
15-
BuildTime = "unknown"
16-
)
17-
18-
// 导出版本信息供其他包使用
19-
func GetVersion() string { return Version }
20-
func GetCommit() string { return Commit }
21-
func GetBuildTime() string { return BuildTime }
22-
2311
func main() {
2412
// 检查并下载必要的数据文件
2513
downloader := data.NewDownloader()

0 commit comments

Comments
 (0)