diff --git a/README.md b/README.md index 1a98db4..6685fe2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- StarryKit + StarryKit

StarryKit Plugin

@@ -10,7 +10,8 @@

简体中文 · - Get started · + Install · + Usage · Demos · Manual setup · Website @@ -20,19 +21,22 @@ StarryKit Plugin gives Codex, Claude Code, Cursor, OpenCode, OpenClaw, and other The result stays editable in StarryKit. You keep control of the document, the review process, and the final export. -## Install with one prompt +## Install -Send this prompt to your agent: +Send one prompt to your agent: ```text Install the StarryKit Plugin from https://github.com/StarryKit/starrykit-plugin. -Configure the StarryKit Hosted MCP server at https://mcp.starrykit.com/mcp, -install the canonical skill from skills/starrykit-authoring for this agent host, -complete OAuth, and verify the connection by listing my accessible StarryKit documents. -Follow the host-specific guide in docs/ when needed. Never ask me to paste an access token. +Set up its Skill and https://mcp.starrykit.com/mcp for this host. +Complete browser OAuth, then verify by listing my accessible StarryKit documents. +Use the matching docs/ guide if manual steps are needed. Never ask me for a token. ``` -Your agent should detect its host, install the Skill, add the remote MCP connection, open StarryKit's browser-based OAuth flow, and verify the tools. After that, simply ask for an outcome: +For manual installation, choose your host in [Manual setup](#manual-setup). + +## Usage + +After installation, describe the visual outcome you want. StarryKit works for new documents and focused edits to existing ones: ```text Create a five-page pitch deck for an AI travel planner. Make it optimistic, diff --git a/README.zh-CN.md b/README.zh-CN.md index 179295c..10aca0b 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,5 +1,5 @@

- StarryKit + StarryKit

StarryKit Plugin

@@ -10,7 +10,8 @@

English · - 开始使用 · + 安装 · + 使用方法 · 演示 · 手动安装 · 官方网站 @@ -20,19 +21,22 @@ StarryKit Plugin 为 Codex、Claude Code、Cursor、OpenCode、OpenClaw 等兼 所有结果在 StarryKit 中保持可编辑。文档归你所有，页面草稿由你审核，最终版本也由你决定。 -## 用一句 Prompt 完成安装 +## 安装 -把下面这段话发送给你的 Agent： +把这一段话发送给你的 Agent： ```text 请从 https://github.com/StarryKit/starrykit-plugin 安装 StarryKit Plugin。 -配置 https://mcp.starrykit.com/mcp 这个 StarryKit Hosted MCP， -为当前 Agent 宿主安装 skills/starrykit-authoring 下的 canonical Skill， -完成 OAuth，并通过列出我有权访问的 StarryKit 文档来验证连接。 -如果需要，请按 docs/ 下对应宿主的说明操作。不要让我在聊天中粘贴 access token。 +为当前宿主配置其中的 Skill 和 https://mcp.starrykit.com/mcp。 +完成浏览器 OAuth，然后通过列出我有权访问的 StarryKit 文档来验证连接。 +如果需要手动操作，请使用 docs/ 中对应的指南。不要向我索要 token。 ``` -Agent 会识别当前宿主、安装 Skill、添加远程 MCP、打开 StarryKit 浏览器 OAuth，并验证工具是否可用。完成后，直接描述你想要的结果： +需要手动安装时，请在[手动安装](#手动安装)中选择对应宿主。 + +## 使用方法 + +安装完成后，直接描述你想要的视觉结果。StarryKit 既可以创建新文档，也可以针对已有文档完成精确修改： ```text 帮我做一份五页的 AI 旅行规划产品 Pitch Deck。整体乐观、有编辑感、 diff --git a/assets/brand/starrykit-wordmark-on-purple.svg b/assets/brand/starrykit-wordmark-on-purple.svg new file mode 100644 index 0000000..e9c55f5 --- /dev/null +++ b/assets/brand/starrykit-wordmark-on-purple.svg @@ -0,0 +1,20 @@ + + StarryKit logo on Starry Purple + White StarryKit mark and outlined Urbanist 700 wordmark on a Starry Purple background. + + + + + + + + + + + + + + diff --git a/tests/plugin.test.mjs b/tests/plugin.test.mjs index 8f13156..90d6f75 100644 --- a/tests/plugin.test.mjs +++ b/tests/plugin.test.mjs @@ -112,7 +112,7 @@ describe("plugin bundle", () => { } for (const asset of [ - "assets/brand/starrykit-wordmark.svg", + "assets/brand/starrykit-wordmark-on-purple.svg", "assets/demos/roadtrip-editing-poster.webp", "assets/demos/roadtrip-editing.mp4", "assets/demos/event-design-poster.webp",