Skip to content

docs: README 精简为两条命令安装,部署细节移到部署指南 - #42

Merged
lazyalex616 merged 2 commits into
allocnode:mainfrom
lazyalex616:docs/readme-slim
Nov 2, 2026
Merged

lazyalex616 merged 2 commits into
allocnode:mainfrom
lazyalex616:docs/readme-slim

Conversation

@lazyalex616

Copy link
Copy Markdown
Collaborator

README 从 580 行精简到约 380 行(其中约 140 行是折叠的工具表),安装改为两条命令:

npx -y add-mcp oh-my-sage-mcp -g -n oh-my-sage --env GATEWAY_URL=http://<网关 IP>
npx -y skills add allocnode/oh-my-sage --skill mijia-automation -g

add-mcp 会列出本机的 AI Agent 让用户勾选,并按各自格式写配置。实测(Claude Code、Cursor、OpenCode):stdio 的 env、HTTP 的 headers 都写对了,带注释的 JSONC 配置也保留了注释。

主要变化:

  • 「两种用法」「选一种用法」「方式一/方式二」多层结构合并为:准备 → 安装两条命令 → 不想每次输登录码(本机常驻 / NAS)→ 升级与卸载。
  • 本机常驻和连接 NAS 后,同样用 add-mcp 一条命令改 AI Agent 配置,不再手抄 JSON。
  • 手动 JSON 配置、网页版安装折叠进 <details>;Docker 分步说明只保留在 deploy/README.md。
  • 「每一步都看得见」和「规则文本格式」合并为「写入前一定校验」;项目结构并入「参与贡献」。
  • 删除不再引用的 docs/images/install.webp。
  • AGENTS.md 同步文档分工说明。

版本号 0.1.2 → 0.1.3,只为让 npm 包页面上的 README 跟着更新,代码无变化。

@lazyalex616
lazyalex616 merged commit 174d9ec into allocnode:main Nov 2, 2026
11 checks passed
@lazyalex616
lazyalex616 deleted the docs/readme-slim branch November 2, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant