Skip to content

Commit f92ab6f

Browse files
committed
docs: add quick start guides to both english and chinese readmes
Add step-by-step quick start instructions including installation, workspace initialization, host startup, and artifact creation notes for both README.md and README.zh-CN.md
1 parent 9ddd238 commit f92ab6f

2 files changed

Lines changed: 54 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,33 @@ Canvas prompt routing uses artifact metadata, block ids, optional implementation
7676
- Local reuse: Canvas makes the nearest correct primitive, hook, helper, schema, fixture, or asset easier to find.
7777
- Guarded boundaries: artifact source stays separate from host internals, old runtime surfaces, generated bundles, and privileged APIs.
7878

79+
## Quick Start
80+
81+
Install the npm package:
82+
83+
```bash
84+
npm install agent-html
85+
```
86+
87+
Create a local Canvas workspace:
88+
89+
```bash
90+
npx agent-html init
91+
```
92+
93+
Start the Canvas host:
94+
95+
```bash
96+
npx agent-html dev
97+
```
98+
99+
Then ask your agent to build or revise a React artifact in `agent-html/artifacts`:
100+
101+
```text
102+
Build a dashboard artifact in agent-html/artifacts using Agent-HTML Canvas.
103+
Read agent-html/README.md and agent-html/AGENTS.md first.
104+
```
105+
79106
## Documentation
80107

81108
- [Canvas docs](./apps/docs/content/docs/canvas/index.mdx): current Canvas constitution, architecture, workspace, host, design-system, and reference docs.

README.zh-CN.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,33 @@ Canvas prompt routing 使用 artifact metadata、block ids、可选 implementati
7676
- 本地复用:Canvas 让最近的正确 primitive、hook、helper、schema、fixture 或 asset 更容易被找到。
7777
- 边界保护:artifact source 与 host internals、old runtime surfaces、generated bundles 和 privileged APIs 保持分离。
7878

79+
## 快速开始
80+
81+
安装 npm 包:
82+
83+
```bash
84+
npm install agent-html
85+
```
86+
87+
创建本地 Canvas 工作区:
88+
89+
```bash
90+
npx agent-html init
91+
```
92+
93+
启动 Canvas host:
94+
95+
```bash
96+
npx agent-html dev
97+
```
98+
99+
然后让你的 agent 在 `agent-html/artifacts` 里创建或修改 React artifact:
100+
101+
```text
102+
使用 Agent-HTML Canvas 在 agent-html/artifacts 里创建一个 dashboard artifact。
103+
请先阅读 agent-html/README.md 和 agent-html/AGENTS.md。
104+
```
105+
79106
## 文档
80107

81108
- [Canvas docs](./apps/docs/content/docs/canvas/index.mdx):当前 Canvas constitution、architecture、workspace、host、design-system 和 reference docs。

0 commit comments

Comments
 (0)