docs: add introduce video and optimize pkg readme (#39)

* docs: add introduce video and optimize pkg readme * docs: update introduce video
web-infra-dev · Aug 5, 2024 · df12c7e · df12c7e
1 parent c17f2c3
commit df12c7e
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 55 deletions.
diff --git a/README.zh.md b/README.zh.md
@@ -22,6 +22,10 @@
 
 Midscene.js 是一个由 AI 驱动的自动化 SDK，能够使用自然语言对网页进行操作、验证，并提取 JSON 格式的数据。
 
+<p align="center">
+  <video src="https://github.com/user-attachments/assets/995486bf-0905-43a0-ae33-234b1307dcf1" controls/>
+</p>
+
 ## 特性 ✨
 
 - **自然语言互动 👆**：只需描述你的步骤，Midscene 会为你规划和操作用户界面

diff --git a/apps/site/docs/en/docs/getting-started/introduction.mdx b/apps/site/docs/en/docs/getting-started/introduction.mdx
@@ -6,6 +6,8 @@ Introducing Midscene.js, an innovative SDK designed to bring joy back to program
 
 Midscene.js leverages a multimodal Large Language Model (LLM) to intuitively “understand” your user interface and carry out the necessary actions. You can simply describe the interaction steps or expected data formats, and the AI will handle the execution for you.
 
+<video src="/introduce/ai-todo.mp4" controls/>
+
 ## Features
 
 ### Interact, query and assert by natural language

diff --git a/apps/site/docs/public/introduce/ai-todo.mp4 b/apps/site/docs/public/introduce/ai-todo.mp4
diff --git a/apps/site/docs/zh/docs/getting-started/introduction.mdx b/apps/site/docs/zh/docs/getting-started/introduction.mdx
@@ -6,6 +6,8 @@ UI 自动化太难写了。自动化脚本里到处都是选择器，比如 `#id
 
 Midscene.js 采用了多模态大语言模型（LLM），能够直观地“理解”你的用户界面并执行必要的操作。你只需描述交互步骤或期望的数据格式，AI 就能为你完成任务。
 
+<video src="/introduce/ai-todo.mp4" controls/>
+
 ## 特性
 
 ### 开箱即用的大型语言模型 (LLM)

diff --git a/packages/midscene/README.md b/packages/midscene/README.md
@@ -0,0 +1,7 @@
+## Documentation
+
+See https://midscenejs.com/ for details.
+
+## License
+
+Midscene is MIT licensed.
diff --git a/packages/visualizer-report/README.md b/packages/visualizer-report/README.md
@@ -1,37 +1,7 @@
-# Modern.js App
+## Documentation
 
-## Setup
+See https://midscenejs.com/ for details.
 
-Install the dependencies:
+## License
 
-```bash
-pnpm install
-```
-
-## Get Started
-
-Start the dev server:
-
-```bash
-pnpm dev
-```
-
-Enable optional features or add a new entry:
-
-```bash
-pnpm new
-```
-
-Build the app for production:
-
-```bash
-pnpm build
-```
-
-Preview the production build locally:
-
-```bash
-pnpm serve
-```
-
-For more information, see the [Modern.js documentation](https://modernjs.dev/en).
+Midscene is MIT licensed.
diff --git a/packages/visualizer/README.md b/packages/visualizer/README.md
@@ -1,24 +1,7 @@
-# visualizer
+## Documentation
 
-## Get Started
+See https://midscenejs.com/ for details.
 
-按开发环境的要求，运行和调试项目
-
-运行和调试组件
-
-```
-pnpm run dev
-```
-
-按照社区规范和最佳实践，生成构建产物
-
-```
-pnpm run build
-```
-
-继续创建更多项目要素
-
-```
-pnpm run new
-```
+## License
 
+Midscene is MIT licensed.
diff --git a/packages/web-integration/README.md b/packages/web-integration/README.md
@@ -0,0 +1,7 @@
+## Documentation
+
+See https://midscenejs.com/ for details.
+
+## License
+
+Midscene is MIT licensed.