Skip to content

Commit a8bf757

Browse files
committed
更新readme文件
1 parent 2eae5c5 commit a8bf757

File tree

1 file changed

+50
-7
lines changed

1 file changed

+50
-7
lines changed

README.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
</div>
1111

12+
> **推荐搭配**:本项目建议配合 [WXAUTO-MGT](https://github.com/zj591227045/WXAUTO-MGT) 项目使用,可以获得最佳体验。
13+
1214
基于wxauto的微信HTTP API接口,提供简单易用的HTTP API调用微信功能,同时支持可选的wxautox扩展功能。通过本项目,您可以轻松地将微信集成到您的应用程序中。
1315

1416
## ✨ 功能特点
@@ -31,6 +33,23 @@
3133

3234
### 安装步骤
3335

36+
#### 方式一:使用打包版本(推荐)
37+
38+
1. **下载最新发布版本**
39+
-[Releases](https://github.com/yourusername/wxauto_http_api/releases) 页面下载最新的 `wxauto_http_api.zip` 文件
40+
- 解压到任意目录(路径中最好不要包含中文和特殊字符)
41+
42+
2. **直接运行**
43+
- 双击 `wxauto_http_api.exe` 启动图形界面(推荐)
44+
- 或者使用 `start_ui.bat` 启动图形界面
45+
- 或者使用 `start_api.bat` 仅启动API服务
46+
47+
3. **安装wxautox(可选)**
48+
- 如果需要使用wxautox增强功能,可以在图形界面中点击"安装wxautox"按钮
49+
- 选择解压目录中的 `lib/wxautox-*.whl` 文件进行安装
50+
51+
#### 方式二:从源码安装
52+
3453
1. **克隆本仓库**
3554

3655
```bash
@@ -57,9 +76,16 @@ python main.py --service ui
5776

5877
### 启动方式
5978

60-
本项目提供两种启动方式:
79+
本项目提供三种启动方式:
80+
81+
1. **可执行文件直接运行**(最简单)
82+
83+
```bash
84+
# 直接双击可执行文件
85+
wxauto_http_api.exe
86+
```
6187

62-
1. **图形界面模式**推荐
88+
2. **图形界面模式**开发环境
6389

6490
```bash
6591
# 方式1:使用Python命令
@@ -69,7 +95,7 @@ python main.py --service ui
6995
start_ui.bat
7096
```
7197

72-
2. **仅API服务模式**
98+
3. **仅API服务模式**
7399

74100
```bash
75101
# 方式1:使用Python命令
@@ -239,28 +265,45 @@ wxauto_http_api/
239265
│ ├── config.py # 配置模块
240266
│ ├── logs.py # 日志模块
241267
│ ├── plugin_manager.py # 插件管理模块
242-
│ └── wechat/ # 微信功能实现
268+
│ ├── wechat/ # 微信功能实现
269+
│ ├── api_service.py # API服务实现
270+
│ ├── app_ui.py # UI界面实现
271+
│ ├── app_mutex.py # 互斥锁机制
272+
│ ├── ui_service.py # UI服务实现
273+
│ └── run.py # API运行模块
243274
├── build_tools/ # 打包工具
275+
│ ├── build_app.py # 打包脚本
276+
│ ├── build_app.bat # 打包批处理文件
277+
│ ├── create_icon.py # 创建图标脚本
278+
│ └── *.spec # PyInstaller规范文件
244279
├── data/ # 数据文件
245280
│ ├── api/ # API数据
246-
│ └── logs/ # 日志文件
281+
│ │ ├── config/ # 配置文件
282+
│ │ ├── logs/ # API日志
283+
│ │ └── temp/ # 临时文件
284+
│ └── logs/ # 系统日志
247285
├── docs/ # 文档
286+
│ ├── ARCHITECTURE_README.md # 架构说明
287+
│ └── PACKAGING_README.md # 打包说明
248288
├── lib/ # 第三方库
289+
│ └── wxautox-*.whl # wxautox wheel文件
249290
├── wxauto/ # wxauto库
250291
├── .env # 环境变量配置
251292
├── main.py # 主入口点
252293
├── requirements.txt # 依赖项列表
294+
├── initialize_wechat.bat # 初始化微信批处理文件
253295
├── start_api.bat # 启动API服务的批处理文件
254296
└── start_ui.bat # 启动UI服务的批处理文件
255297
```
256298

257299
## ⚠️ 注意事项
258300

259-
- **微信客户端**:请确保微信PC客户端已登录
301+
- **微信客户端**:请确保微信PC客户端已登录,建议使用微信3.9版本
260302
- **窗口状态**:使用过程中请勿关闭微信窗口
261303
- **安全性**:API密钥请妥善保管,避免泄露
262304
- **兼容性**:本项目仅支持Windows操作系统
263-
- **依赖项**:确保已安装所有必要的依赖项
305+
- **依赖项**:使用打包版本无需安装依赖,从源码安装时需确保安装所有必要的依赖项
306+
- **打包版本**:打包版本已包含所有必要的依赖,但不包含wxautox库,需要单独安装
264307

265308
## 📝 许可证
266309

0 commit comments

Comments
 (0)