From e20f53e2536719b41052a0e28ca2d60f92c9372c Mon Sep 17 00:00:00 2001
From: zwbcc <zwbcc@qq.com>
Date: Sat, 28 Mar 2026 21:06:03 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20README=EF=BC=8C?=
 =?UTF-8?q?=E5=AE=8C=E5=96=84=E9=83=A8=E7=BD=B2=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 119 +++++++++++++++++++++++++++++-------------------------
 1 file changed, 65 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index 45a8d57..849899f 100644
--- a/README.md
+++ b/README.md
@@ -1,47 +1,35 @@
 # 图片生成器
 
-MiniMax 文生图工具，访问 `http://域名或IP:8195`
-
----
-
-## 一键部署
-
-```bash
-# SSH 登录目标机器后，一键运行：
-bash <(curl -fsSL https://gitea.zwbcc.cn/zwbpc/image-generator/raw/branch/master/start.sh)
-```
-
-或手动部署：
-
-```bash
-# 1. 安装依赖
-npm i -g express node-fetch
-
-# 2. 下载项目（到 /home/zwbpc/image-generator 或其他目录）
-git clone https://gitea.zwbcc.cn/zwbpc/image-generator.git
-cd image-generator
-
-# 3. 启动
-chmod +x start.sh
-./start.sh
-
-# 4. 配置开机自启（可选）
-# 创建 service：~/.config/systemd/user/image-generator.service
-# 内容见下方「Systemd」小节
-systemctl --user daemon-reload
-systemctl --user enable --now image-generator.service
-```
+MiniMax 文生图工具，基于 `image-01` / `image-01-live` 模型。
 
 **访问：** `http://域名或IP:8195`
 
-**配置 API Key：** 页面右上角 ⚙️ → 填入 MiniMax Key → 保存
-
 ---
 
-## Systemd Service（可选）
+## 部署
 
-```ini
-# ~/.config/systemd/user/image-generator.service
+### 环境要求
+
+- Node.js >= 18
+- npm
+
+### 一键部署
+
+```bash
+# 克隆 + 安装依赖 + 启动
+git clone https://gitea.zwbcc.cn/zwbpc/image-generator.git /home/zwbpc/image-generator \
+  && cd /home/zwbpc/image-generator \
+  && npm i -g express node-fetch \
+  && chmod +x start.sh \
+  && ./start.sh
+```
+
+### 配置开机自启（可选）
+
+```bash
+# 创建 service 文件
+mkdir -p ~/.config/systemd/user
+cat > ~/.config/systemd/user/image-generator.service << 'EOF'
 [Unit]
 Description=MiniMax Image Generator
 After=network.target
@@ -54,13 +42,28 @@ Restart=on-failure
 
 [Install]
 WantedBy=default.target
-```
+EOF
 
-```bash
+# 启用并启动
 systemctl --user daemon-reload
 systemctl --user enable --now image-generator.service
 ```
 
+**重启服务：** `systemctl --user restart image-generator.service`
+
+---
+
+## 配置
+
+首次使用需填写 API Key：
+
+1. 访问页面右上角 **⚙️ 设置**
+2. 填入 MiniMax API Key（格式：`eyJhbGciOiJIUzI1NiIsInR...`）
+3. API 地址默认 `https://api.minimaxi.com`，无需修改
+4. 保存
+
+> 获取地址：https://platform.minimaxi.com/user-center/basic-information/interface-key
+
 ---
 
 ## 项目结构
@@ -68,36 +71,44 @@ systemctl --user enable --now image-generator.service
 ```
 image-generator/
 ├── index.html   # HTML 页面
-├── style.css    # 样式（深色主题）
-├── ui.js        # 前端交互逻辑
-├── app.js       # 服务端（Express）
-├── start.sh     # 启动脚本
-├── config.json  # API Key 存储（自动生成，不提交）
+├── style.css   # 样式（深色主题）
+├── ui.js       # 前端交互逻辑
+├── app.js      # 服务端（Express）
+├── start.sh    # 启动脚本
+├── config.json # API Key 存储（不提交，自动生成）
 └── CHANGELOG.md
 ```
 
 ---
 
-## API 端点
+## API 接口
 
 | 方法 | 路径 | 说明 |
 |------|------|------|
 | `POST` | `/api/generate` | 生成图片 |
-| `GET` | `/api/config` | 获取配置 |
+| `GET` | `/api/config` | 获取配置（不含 Key） |
 | `POST` | `/api/config` | 保存配置 |
 
-**生成参数：**
+### 生成参数
 
-| 参数 | 默认值 | 说明 |
-|------|--------|------|
-| `model` | `image-01` | `image-01` 或 `image-01-live` |
-| `prompt` | — | 图片描述（必填） |
-| `aspect_ratio` | `16:9` | 比例：`1:1` `16:9` `4:3` `3:2` `2:3` `3:4` `9:16` `21:9` |
+| 参数 | 默认 | 说明 |
+|------|------|------|
+| `model` | `image-01` | `image-01` / `image-01-live` |
+| `prompt` | 必填 | 图片描述，最多 1500 字符 |
+| `aspect_ratio` | `16:9` | `1:1` `16:9` `4:3` `3:2` `2:3` `3:4` `9:16` `21:9` |
 | `response_format` | `url` | `url`（24h有效）或 `base64` |
 | `n` | `1` | 数量 1-9 |
 | `seed` | 随机 | 整数，用于复现 |
-| `width` / `height` | — | 自定义分辨率（512-2048，8的倍数） |
-| `style.style_type` | — | 画风：`漫画` `元气` `中世纪` `水彩`（仅 live） |
+| `width` / `height` | — | 自定义分辨率 512-2048（8的倍数） |
+| `style.style_type` | — | 画风：漫画/元气/中世纪/水彩（仅 live） |
 | `style.style_weight` | 0.8 | 画风权重 0.1-1.0（仅 live） |
 
-**常见错误码：** `1002`限流 `1004`鉴权失败 `1008`余额不足 `1026`敏感词 `2049`无效Key
+### 常见错误
+
+| 错误码 | 说明 |
+|--------|------|
+| 1002 | 限流，稍后重试 |
+| 1004 | API Key 错误 |
+| 1008 | 余额不足 |
+| 1026 | 内容含敏感词，修改 Prompt |
+| 2049 | 无效的 API Key |