Add bilingual README and MIT license

Author: Winlifes

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Winlifes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,23 +1,56 @@
 # SimulateInput
 
-Cross-platform desktop and browser automation platform for testing your own websites, desktop applications, installers, and system-level UI flows.
+English | [中文](#中文)
 
-## Features
+SimulateInput is a cross-platform desktop and browser automation platform for testing your own websites, desktop applications, installers, and system-level UI flows.
 
-- Window attach, focus, click, drag, type, hotkey, clear text, and screenshot actions
-- Multiple locator strategies: UIA/AX/AT-SPI style lookup, visible text, OCR, image matching, and coordinate fallback
-- CLI, MCP, and YAML case runner interfaces
-- Windows implementation with real smoke-tested execution
-- macOS MVP, Linux X11 MVP, and Linux Wayland compatibility layer
-- Skill docs for AI-driven automation workflows
+It combines direct input execution, multiple locator strategies, CLI and MCP interfaces, and YAML-driven reusable test cases so the same automation core can be used by engineers, CI pipelines, and AI agents.
 
-## Project Layout
+## Highlights
 
-- `src/simulateinput/` - core engine, drivers, CLI, MCP server, runner, and locators
-- `docs/automation-platform-design.md` - architecture and implementation plan
-- `docs/cross-platform-installation.md` - platform-specific setup and permissions
-- `skills/simulateinput/` - skill definition and MCP/CLI references
-- `tests/` - unit tests and smoke case YAML files
+- Cross-platform driver architecture for Windows, macOS, Linux X11, and Linux Wayland compatibility
+- Multiple locator strategies:
+  - structured accessibility lookup
+  - visible text lookup
+  - OCR-based text lookup
+  - image template matching
+  - coordinate fallback
+- Real input actions:
+  - click
+  - drag
+  - type text
+  - press key
+  - hotkey
+  - clear text
+  - screenshot
+- MCP server for AI tool calling
+- YAML case runner for repeatable automation flows
+- Skill definitions and references for AI-assisted execution
+
+## Current Platform Status
+
+- Windows: primary implementation, real execution and smoke tested
+- macOS: MVP driver implemented, requires Accessibility / Automation / Screen Recording permissions
+- Linux X11: MVP driver implemented, depends on `wmctrl`, `xdotool`, screenshot helpers, and optional AT-SPI tooling
+- Linux Wayland: compatibility layer, helper-tool dependent and not yet full parity
+
+## Repository Structure
+
+- `src/simulateinput/`
+  - core engine
+  - platform drivers
+  - locators
+  - CLI
+  - MCP server
+  - case runner
+- `docs/automation-platform-design.md`
+  - architecture and implementation plan
+- `docs/cross-platform-installation.md`
+  - platform setup, dependencies, and permissions
+- `skills/simulateinput/`
+  - skill definition and CLI / MCP references
+- `tests/`
+  - unit tests and smoke case YAML files
 
 ## Quick Start
 
@@ -28,7 +61,7 @@ python -m simulateinput.cli.main session start
 python -m simulateinput.cli.main mcp tools
 ```
 
-## Common CLI Flow
+## Typical CLI Workflow
 
 ```powershell
 $env:PYTHONPATH='src'
@@ -49,24 +82,21 @@ $env:PYTHONPATH='src'
 python -m simulateinput.cli.main case run tests/e2e/cases/windows-smoke.yaml
 ```
 
-Example step types:
-
-- `attach_window`
-- `locate_text`
-- `locate_uia`
-- `locate_ocr`
-- `locate_image`
-- `click_text`
-- `click_uia`
-- `click_ocr`
-- `click_image`
-- `click`
-- `drag`
-- `type_text`
-- `press_key`
-- `hotkey`
-- `clear_text`
-- `screenshot`
+Example case:
+
+```yaml
+name: locator-smoke
+profile: lab_default
+steps:
+  - action: attach_window
+    title: Notepad
+
+  - action: locate_text
+    text: File
+
+  - action: screenshot
+    output: artifacts/locator-smoke.png
+```
 
 ## MCP
 
@@ -77,24 +107,183 @@ $env:PYTHONPATH='src'
 python -m simulateinput.cli.main mcp serve
 ```
 
-Current MCP tools include session management, window attach, text/UIA/OCR/image lookup, click actions, keyboard actions, drag, and screenshot capture.
-
-## Platform Status
+Current MCP capabilities include:
 
-- `Windows` - primary implementation, real execution and smoke tested
-- `macOS` - MVP driver implemented, requires Accessibility / Automation / Screen Recording permissions
-- `Linux X11` - MVP driver implemented, depends on `wmctrl`, `xdotool`, and a screenshot helper
-- `Linux Wayland` - compatibility layer, helper-tool dependent and not full parity
+- session management
+- window attach
+- structured locators
+- OCR and image locators
+- click and drag actions
+- keyboard actions
+- screenshot capture
 
-## Installation Notes
+## Installation
 
 See `docs/cross-platform-installation.md` for:
 
 - Python dependencies
 - Tesseract OCR setup
 - macOS permissions
-- Linux X11 and Wayland helper packages
+- Linux helper packages
+- platform smoke cases
+
+## Documentation
+
+- Architecture: `docs/automation-platform-design.md`
+- Installation: `docs/cross-platform-installation.md`
+- Skill: `skills/simulateinput/SKILL.md`
+- CLI reference: `skills/simulateinput/references/cli-usage.md`
+- MCP reference: `skills/simulateinput/references/mcp-tools.md`
 
 ## Safety Boundary
 
-This project is intended for automation of your own software, test environments, and explicitly authorized systems. It is not intended for bypassing third-party anti-bot controls or CAPTCHAs.
+SimulateInput is intended for automation of your own software, test environments, and explicitly authorized systems.
+
+It is not intended for bypassing third-party anti-bot controls, CAPTCHAs, or unrelated security mechanisms.
+
+---
+
+## 中文
+
+SimulateInput 是一个跨平台的桌面与浏览器自动化测试平台，用于测试你自己的网页、桌面软件、安装器以及系统级 UI 流程。
+
+它把真实输入执行、多种定位策略、CLI / MCP 接口和 YAML 可复用测试用例整合到同一个自动化核心中，既可以给工程师直接使用，也可以接入 CI 和 AI Agent。
+
+## 核心能力
+
+- 跨平台驱动架构：Windows、macOS、Linux X11，以及 Linux Wayland 兼容层
+- 多种定位方式：
+  - 结构化辅助功能 / 控件树定位
+  - 可见文本定位
+  - OCR 文本定位
+  - 图像模板定位
+  - 坐标兜底
+- 真实输入动作：
+  - 点击
+  - 拖拽
+  - 文本输入
+  - 单键输入
+  - 组合键
+  - 清空文本
+  - 截图
+- MCP 服务，可供 AI 通过工具调用
+- YAML case runner，可执行可复用的自动化测试流程
+- 为 AI 使用准备的 skill 文档和参考资料
+
+## 当前平台状态
+
+- Windows：主实现，已完成真实执行和 smoke test
+- macOS：已完成 MVP 驱动，实现依赖 Accessibility / Automation / Screen Recording 权限
+- Linux X11：已完成 MVP 驱动，依赖 `wmctrl`、`xdotool`、截图工具和可选 AT-SPI 环境
+- Linux Wayland：当前是兼容层，依赖外部 helper，能力还未与 Windows 等价
+
+## 仓库结构
+
+- `src/simulateinput/`
+  - 核心引擎
+  - 平台驱动
+  - 定位器
+  - CLI
+  - MCP 服务
+  - 用例运行器
+- `docs/automation-platform-design.md`
+  - 总体设计稿
+- `docs/cross-platform-installation.md`
+  - 跨平台安装、依赖和权限说明
+- `skills/simulateinput/`
+  - AI skill 定义和 CLI / MCP 参考
+- `tests/`
+  - 单元测试和 smoke case YAML
+
+## 快速开始
+
+```powershell
+$env:PYTHONPATH='src'
+python -m simulateinput.cli.main doctor
+python -m simulateinput.cli.main session start
+python -m simulateinput.cli.main mcp tools
+```
+
+## 常见 CLI 流程
+
+```powershell
+$env:PYTHONPATH='src'
+
+python -m simulateinput.cli.main session start
+python -m simulateinput.cli.main window list --session-id <session_id>
+python -m simulateinput.cli.main window attach --session-id <session_id> --window-id <window_id>
+
+python -m simulateinput.cli.main locate uia --session-id <session_id> --name "Submit"
+python -m simulateinput.cli.main action click-uia --session-id <session_id> --name "Submit"
+python -m simulateinput.cli.main action screenshot --session-id <session_id> --output artifacts/shot.png
+```
+
+## YAML 用例执行
+
+```powershell
+$env:PYTHONPATH='src'
+python -m simulateinput.cli.main case run tests/e2e/cases/windows-smoke.yaml
+```
+
+示例：
+
+```yaml
+name: locator-smoke
+profile: lab_default
+steps:
+  - action: attach_window
+    title: Notepad
+
+  - action: locate_text
+    text: File
+
+  - action: screenshot
+    output: artifacts/locator-smoke.png
+```
+
+## MCP 接入
+
+启动本地 MCP 服务：
+
+```powershell
+$env:PYTHONPATH='src'
+python -m simulateinput.cli.main mcp serve
+```
+
+当前 MCP 已支持：
+
+- 会话管理
+- 窗口附着
+- 结构化定位
+- OCR / 图像定位
+- 点击与拖拽
+- 键盘动作
+- 截图
+
+## 安装说明
+
+详见 `docs/cross-platform-installation.md`，其中包含：
+
+- Python 依赖
+- Tesseract OCR 安装
+- macOS 权限配置
+- Linux helper 工具安装
+- 平台 smoke case 说明
+
+## 文档
+
+- 架构设计：`docs/automation-platform-design.md`
+- 安装文档：`docs/cross-platform-installation.md`
+- Skill：`skills/simulateinput/SKILL.md`
+- CLI 参考：`skills/simulateinput/references/cli-usage.md`
+- MCP 参考：`skills/simulateinput/references/mcp-tools.md`
+
+## 安全边界
+
+SimulateInput 只应用于：
+
+- 你自己的软件
+- 测试环境
+- 经过明确授权的系统
+
+它不用于绕过第三方反自动化机制、验证码或无关安全控制。