diff --git a/README.md b/README.md index 9dfb81f..e72681c 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua 🌐 **English** | [中文](./docs/README-zh.md) -👉 🚀 Demo | 📖 Documentation | 📢 Join HN Discussion +👉 🚀 Demo | 📖 Documentation | 📢 Join HN Discussion @@ -22,20 +22,18 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua - **🎯 Easy integration** - No need for `browser extension` / `python` / `headless browser`. - Just in-page javascript. Everything happens in your web page. - - The best tool for your agent to control web pages. - **📖 Text-based DOM manipulation** - - No screenshots. No OCR or multi-modal LLMs needed. - - No special permissions required. + - No screenshots. No multi-modal LLMs or special permissions needed. - **🧠 Bring your own LLMs** - **🎨 Pretty UI with human-in-the-loop** - **🐙 Optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension) for multi-page tasks.** ## 💡 Use Cases -- **SaaS AI Copilot** — Ship an AI copilot in your product in lines of code. No backend rewrite needed. +- **SaaS AI Copilot** — Ship an AI copilot in your product in lines of code. No backend rewrite. - **Smart Form Filling** — Turn 20-click workflows into one sentence. Perfect for ERP, CRM, and admin systems. - **Accessibility** — Make any web app accessible through natural language. Voice commands, screen readers, zero barrier. -- **Multi-page Agent** — Extend your agent's reach across browser tabs with the optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension). +- **Multi-page Agent** — Extend your own agent's reach across browser tabs with the optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension). ## 🚀 Quick Start @@ -47,13 +45,13 @@ Fastest way to try PageAgent with our free Demo LLM: ``` +> **⚠️ For technical evaluation only.** This demo CDN uses our free [testing LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api). By using it, you agree to its [terms](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md). + | Mirrors | URL | | ------- | ---------------------------------------------------------------------------------- | | Global | https://cdn.jsdelivr.net/npm/page-agent@1.5.6/dist/iife/page-agent.demo.js | | China | https://registry.npmmirror.com/page-agent/1.5.6/files/dist/iife/page-agent.demo.js | -> **⚠️ For technical evaluation only.** This demo CDN uses our free [testing LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api). By using it, you agree to its [terms](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md). - ### NPM Installation ```bash @@ -77,7 +75,7 @@ For more programmatic usage, see [📖 Documentations](https://alibaba.github.io ## 🤝 Contributing -We welcome contributions from the community! Follow our instructions in [CONTRIBUTING.md](CONTRIBUTING.md) for environment setup and local development. +We welcome contributions from the community! Follow our instructions in [CONTRIBUTING.md](CONTRIBUTING.md) for setup and guidelines. Please read [Code of Conduct](docs/CODE_OF_CONDUCT.md) before contributing. @@ -90,12 +88,10 @@ This project builds upon the excellent work of **[`browser-use`](https://github. ``` DOM processing components and prompt are derived from browser-use: -Browser Use +Browser Use Copyright (c) 2024 Gregor Zunic Licensed under the MIT License -Original browser-use project: - We gratefully acknowledge the browser-use project and its contributors for their excellent work on web automation and DOM interaction patterns that helped make this project possible. @@ -114,8 +110,8 @@ file and in the node_modules directory after installation. - - - Star History Chart + + + Star History Chart diff --git a/docs/README-zh.md b/docs/README-zh.md index 7f827a1..699c7f1 100644 --- a/docs/README-zh.md +++ b/docs/README-zh.md @@ -11,7 +11,7 @@ 🌐 [English](../README.md) | **中文** -👉 🚀 Demo | 📖 Documentation +👉 🚀 Demo | 📖 Documentation | 📢 Join HN Discussion @@ -22,20 +22,18 @@ - **🎯 轻松集成** - 无需 `浏览器插件` / `Python` / `无头浏览器`。 - 纯页面内 JavaScript，一切都在你的网页中完成。 - - The best tool for your agent to control web pages. - **📖 基于文本的 DOM 操作** - - 无需截图，无需 OCR 或多模态模型。 - - 无需特殊权限。 + - 无需截图，无需多模态模型或特殊权限。 - **🧠 用你自己的 LLM** - **🎨 精美 UI，支持人机协同** - **🐙 可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension)，支持跨页面任务。** ## 💡 应用场景 -- **SaaS AI 副驾驶** — 几行代码为你的产品加上 AI 副驾驶，不需要重写后端。 +- **SaaS AI 副驾驶** — 几行代码为你的产品加上 AI 副驾驶，无需重写后端。 - **智能表单填写** — 把 20 次点击变成一句话。ERP、CRM、管理后台的最佳拍档。 - **无障碍增强** — 用自然语言让任何网页无障碍。语音指令、屏幕阅读器，零门槛。 -- **跨页面 Agent** — 通过可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension)，让你的 Agent 跨标签页工作。 +- **跨页面 Agent** — 通过可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension)，让你自己的 Agent 跨标签页工作。 ## 🚀 快速开始 @@ -47,13 +45,13 @@ ``` +> **⚠️ 仅用于技术评估。** 该 Demo CDN 使用了免费的[测试 LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api)，使用即表示您同意其[条款](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md)。 + | Mirrors | URL | | ------- | ---------------------------------------------------------------------------------- | | Global | https://cdn.jsdelivr.net/npm/page-agent@1.5.6/dist/iife/page-agent.demo.js | | China | https://registry.npmmirror.com/page-agent/1.5.6/files/dist/iife/page-agent.demo.js | -> **⚠️ 仅用于技术评估。** 该 Demo CDN 使用了免费的[测试 LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api)，使用即表示您同意其[条款](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md)。 - ### NPM 安装 ```bash @@ -77,7 +75,7 @@ await agent.execute('点击登录按钮') ## 🤝 贡献 -欢迎社区贡献！请参阅 [CONTRIBUTING.md](../CONTRIBUTING.md) 了解环境配置和本地开发说明。 +欢迎社区贡献！请参阅 [CONTRIBUTING.md](../CONTRIBUTING.md) 了解安装与贡献指南。 请在贡献前阅读[行为准则](CODE_OF_CONDUCT.md)。 @@ -90,12 +88,10 @@ await agent.execute('点击登录按钮') ``` DOM processing components and prompt are derived from browser-use: -Browser Use +Browser Use Copyright (c) 2024 Gregor Zunic Licensed under the MIT License -Original browser-use project: - We gratefully acknowledge the browser-use project and its contributors for their excellent work on web automation and DOM interaction patterns that helped make this project possible. @@ -114,8 +110,8 @@ file and in the node_modules directory after installation. - - - Star History Chart + + + Star History Chart