diff --git a/README-zh.md b/README-zh.md index 87d8a53..d5509f9 100644 --- a/README-zh.md +++ b/README-zh.md @@ -20,20 +20,23 @@ ## ✨ Features - **🎯 轻松集成** + - 无需 Python,无需无头浏览器,无需浏览器插件。纯页面内脚本。 - **🔐 端侧运行** - **🧠 HTML 脱水** - **💬 自然语言接口** - **🎨 HITL 交互界面** -## 🗺️ Roadmap +以及 😉 -👉 [**Roadmap**](https://github.com/alibaba/page-agent/issues/96) +- **🧪 实验性的 Chrome 扩展,支持跨页面控制** - `-b feat/ext` + +👉 [**🗺️ Roadmap**](https://github.com/alibaba/page-agent/issues/96) ## 🚀 快速开始 -### 快速体验 (With Testing LLM) +### 一行代码集成 -最快的体验方式: +通过我们免费的 Demo LLM 快速体验 PageAgent: ```html ``` -> ⚠️ **仅用于技术评估。** Demo 模型有速率限制和使用限制,生产环境请使用 NPM 方式。 +> - **⚠️ 仅用于技术评估。** Demo LLM 有速率和使用限制,可能随时变更。 +> - **🌷 建议使用自己的 LLM API。** | 镜像 | URL | | ------ | ----------------------------------------------------------------------------------------- | @@ -86,15 +90,9 @@ packages/ ## 🤝 贡献 -欢迎社区贡献!以下是参与方式: +欢迎社区贡献!请参阅 [CONTRIBUTING.md](CONTRIBUTING.md) 了解环境配置和本地开发说明。 -1. Fork 并 clone。`git clone https://github.com/alibaba/page-agent.git && cd page-agent` -2. 安装依赖: `npm install` -3. 启动开发: `npm start` - -更多详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。 - -请在贡献前阅读我们的[行为准则](CODE_OF_CONDUCT.md)。 +请在贡献前阅读[行为准则](CODE_OF_CONDUCT.md)。 ## 👏 致谢 diff --git a/README.md b/README.md index b8b8626..958f351 100644 --- a/README.md +++ b/README.md @@ -19,21 +19,24 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua ## ✨ Features -- **🎯 Easy Integration** - Transform your webpage into an agent with a single script tag. +- **🎯 Easy Integration** + - No python. No headless browser. No browser extension. Just in-page scripts. - **🔐 Client-Side Processing** - **🧠 DOM Extraction** - **💬 Natural Language Interface** - **🎨 UI with Human in the loop** -## 🗺️ Roadmap +And 😉 -👉 [**Roadmap**](https://github.com/alibaba/page-agent/issues/96) +- **🧪 `cross-page` control with an experimental chrome extension** - `-b feat/ext` + +👉 [**🗺️ Roadmap**](https://github.com/alibaba/page-agent/issues/96) ## 🚀 Quick Start -### Quick Try (With Testing LLM) +### One-line integration -Fastest way to try PageAgent: +Fastest way to try PageAgent with our free Demo LLM: ```html ``` -> ⚠️ **For technical evaluation only.** Demo model has rate limits and usage restrictions. Use NPM for production. +> - **⚠️ For technical evaluation only.** Demo LLM has rate limits and usage restrictions. May change without notice. +> - **🌷 Bring your own LLM API.** | Mirrors | URL | | ------- | ----------------------------------------------------------------------------------------- | @@ -84,15 +88,9 @@ packages/ ## 🤝 Contributing -We welcome contributions from the community! Here's how to get started: +We welcome contributions from the community! Follow our instructions in [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup and local development. -1. Fork and clone. `git clone https://github.com/alibaba/page-agent.git && cd page-agent` -2. Install dependencies: `npm install` -3. Start development: `npm start` - -More details in [CONTRIBUTING.md](CONTRIBUTING.md). - -Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. +Please read [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. ## 👏 Acknowledgments