1 files changed, 79 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6cdc38b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,79 @@
+# MiMo V2.5 TTS — Hermes Agent Plugin
+
+Xiaomi MiMo V2.5 语音合成插件，为 Hermes Agent 提供高质量中英文 TTS 能力。
+
+## 功能
+
+- 9 个内置音色（4 中文 + 4 英文 + 1 自动）
+- 3 种模型：内置音色 / 语音设计 / 声音克隆
+- 自然语言风格控制（播音员、讲故事、方言、情绪等）
+- 流式输出支持
+- 兼容 Hermes 语音气泡投递（Telegram 等）
+
+## 音色列表
+
+| ID | 名称 | 语言 | 性别 |
+|----|------|------|------|
+| `mimo_default` | 默认 | 自动 | - |
+| `冰糖` | Bingtang | 中文 | 女 |
+| `茉莉` | Moli | 中文 | 女 |
+| `苏打` | Suda | 中文 | 男 |
+| `白桦` | Baihua | 中文 | 男 |
+| `Mia` | Mia | 英文 | 女 |
+| `Chloe` | Chloe | 英文 | 女 |
+| `Milo` | Milo | 英文 | 男 |
+| `Dean` | Dean | 英文 | 男 |
+
+## 使用示例
+
+### Hermes 内置调用
+
+配置完成后，Hermes 的 `text_to_speech` 工具会自动走 MiMo：
+
+```
+text_to_speech(text="你好世界")
+```
+
+### 独立命令行
+
+```bash
+# 基本用法
+python3 ~/mimo_tts.py "你好世界" --voice 冰糖
+
+# 指定输出路径
+python3 ~/mimo_tts.py "测试" --voice 茉莉 -o output.wav
+
+# 列出音色 / 模型
+python3 ~/mimo_tts.py --list-voices
+python3 ~/mimo_tts.py --list-models
+```
+
+### Python API
+
+```python
+import sys, os
+sys.path.insert(0, os.path.expanduser("~/.hermes/hermes-agent"))
+os.environ.setdefault("XIAOMI_API_KEY", "your_key")
+
+import importlib.util
+spec = importlib.util.spec_from_file_location(
+    "mimo_tts", os.path.expanduser("~/.hermes/plugins/tts/mimo/__init__.py")
+)
+mod = importlib.util.module_from_spec(spec)
+spec.loader.exec_module(mod)
+
+provider = mod.MiMoTTSProvider()
+provider.synthesize("你好世界", "output.wav", voice="冰糖")
+```
+
+## 文件说明
+
+```
+mimo-tts-for-hermes/
+├── README.md          # 本文档（介绍）
+├── INSTALL.md         # 安装说明（给 Agent 看）
+├── plugin.yaml        # Hermes 插件清单
+├── setup.sh           # 安装/卸载脚本（仅供参考）
+├── __init__.py        # 插件注册入口 + TTSProvider 实现
+└── mimo_tts.py        # 独立命令行脚本
+```