From 8bc2483ab5c42382a966331064c92ed760524d83 Mon Sep 17 00:00:00 2001 From: Simon <10131203+gaomeng1900@users.noreply.github.com> Date: Mon, 6 Jul 2026 16:53:43 +0800 Subject: [PATCH] docs: improve README copy and quick start (#592) * docs: improve README copy and quick start * docs: put each badge on its own line --- README.md | 34 +++++++++++++++++----------------- docs/README-zh.md | 20 +++++++++++++++----- 2 files changed, 32 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c55945a..8c3c6e0 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,18 @@ Page Agent Banner -[![License: MIT](https://img.shields.io/badge/License-MIT-auto.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/page-agent)](https://bundlephobia.com/package/page-agent) [![Downloads](https://img.shields.io/npm/dt/page-agent.svg)](https://www.npmjs.com/package/page-agent) [![GitHub stars](https://img.shields.io/github/stars/alibaba/page-agent.svg)](https://github.com/alibaba/page-agent) +[![CI](https://img.shields.io/github/actions/workflow/status/alibaba/page-agent/ci.yml?branch=main&style=flat-square&label=ci)](https://github.com/alibaba/page-agent/actions/workflows/ci.yml) +[![npm](https://img.shields.io/npm/v/page-agent?style=flat-square&label=npm)](https://www.npmjs.com/package/page-agent) +[![downloads](https://img.shields.io/npm/dt/page-agent?style=flat-square)](https://www.npmjs.com/package/page-agent) +[![size](https://img.shields.io/bundlephobia/minzip/page-agent?style=flat-square&label=size)](https://bundlephobia.com/package/page-agent) +[![license](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://opensource.org/licenses/MIT) +[![typescript](https://img.shields.io/badge/%3C%2F%3E-typescript-blue?style=flat-square)](http://www.typescriptlang.org/) +[![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/akldabonmimlicnjlflnapfeklbfemhj?style=flat-square&label=chrome%20rating)](https://chromewebstore.google.com/detail/page-agent-ext/akldabonmimlicnjlflnapfeklbfemhj) +[![GitHub stars](https://img.shields.io/github/stars/alibaba/page-agent.svg)](https://github.com/alibaba/page-agent) -The GUI Agent Living in Your Webpage. Control web interfaces with natural language. +The GUI Agent Living in Your Webpage. One script gives any web page its own AI agent. + +alibaba%2Fpage-agent | Trendshift 🌐 **English** | [中文](./docs/README-zh.md) @@ -15,7 +24,7 @@ The GUI Agent Living in Your Webpage. Control web interfaces with natural langua -https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 +[![Watch the demo](https://page-agent.github.io/assets/readme/poster.jpg)](https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2) --- @@ -27,6 +36,7 @@ https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 - **📖 Text-based DOM manipulation** - No screenshots. No multi-modal LLMs or special permissions needed. - **🧠 Bring your own LLMs** + - Works with most mainstream models, including locally deployed ones. See [supported models](https://alibaba.github.io/page-agent/docs/features/models). - **🐙 Optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension) for multi-page tasks.** - And an [MCP Server (Beta)](https://alibaba.github.io/page-agent/docs/features/mcp-server) to control it from outside @@ -35,7 +45,7 @@ https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 - **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 own web agent's reach across browser tabs [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension). +- **Multi-page Agent** — Extend your own web agent's reach across browser tabs via the [Chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension). - **MCP** - Allow your agent clients to control your browser. ## 🚀 Quick Start @@ -45,7 +55,7 @@ https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 Fastest way to try PageAgent with our free Demo LLM: ```html - + ``` > **⚠️ 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). @@ -78,20 +88,12 @@ await agent.execute('Click the login button') For more programmatic usage, see [📖 Documentations](https://alibaba.github.io/page-agent/docs/introduction/overview). -## 🌟 Awesome Page Agent - -Built something cool with PageAgent? Add it here! Open a PR to share your project. - -> These are community projects — not maintained or endorsed by us. Use at your own discretion. - -| Project | Description | -| -------- | ----------------------------------------------------------- | -| _Yours?_ | [Open a PR](https://github.com/alibaba/page-agent/pulls) 🙌 | - ## 🤝 Contributing We welcome contributions from the community! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and [docs/developer-guide.md](docs/developer-guide.md) for local development workflows. +Built something cool with PageAgent? Share it in [Show and Tell](https://github.com/alibaba/page-agent/discussions/categories/show-and-tell). 🙌 + Please read the [maintainer's note](https://github.com/alibaba/page-agent/issues/349) on principles and current state. Contributions generated entirely by **bots or AI** without substantial human involvement will **not be accepted**. @@ -118,6 +120,4 @@ excellent work on web automation and DOM interaction patterns that helped make this project possible. ``` ---- - **⭐ Star this repo if you find PageAgent helpful!** diff --git a/docs/README-zh.md b/docs/README-zh.md index c36a4fc..07a7ddf 100644 --- a/docs/README-zh.md +++ b/docs/README-zh.md @@ -5,17 +5,26 @@ Page Agent Banner -[![License: MIT](https://img.shields.io/badge/License-MIT-auto.svg)](https://opensource.org/licenses/MIT) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/page-agent)](https://bundlephobia.com/package/page-agent) [![Downloads](https://img.shields.io/npm/dt/page-agent.svg)](https://www.npmjs.com/package/page-agent) [![GitHub stars](https://img.shields.io/github/stars/alibaba/page-agent.svg)](https://github.com/alibaba/page-agent) +[![CI](https://img.shields.io/github/actions/workflow/status/alibaba/page-agent/ci.yml?branch=main&style=flat-square&label=ci)](https://github.com/alibaba/page-agent/actions/workflows/ci.yml) +[![npm](https://img.shields.io/npm/v/page-agent?style=flat-square&label=npm)](https://www.npmjs.com/package/page-agent) +[![downloads](https://img.shields.io/npm/dt/page-agent?style=flat-square)](https://www.npmjs.com/package/page-agent) +[![size](https://img.shields.io/bundlephobia/minzip/page-agent?style=flat-square&label=size)](https://bundlephobia.com/package/page-agent) +[![license](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://opensource.org/licenses/MIT) +[![typescript](https://img.shields.io/badge/%3C%2F%3E-typescript-blue?style=flat-square)](http://www.typescriptlang.org/) +[![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/akldabonmimlicnjlflnapfeklbfemhj?style=flat-square&label=chrome%20rating)](https://chromewebstore.google.com/detail/page-agent-ext/akldabonmimlicnjlflnapfeklbfemhj) +[![GitHub stars](https://img.shields.io/github/stars/alibaba/page-agent.svg)](https://github.com/alibaba/page-agent) 纯 JS 实现的 GUI agent。使用自然语言操作你的 Web 应用。无须后端、客户端、浏览器插件。 +alibaba%2Fpage-agent | Trendshift + 🌐 [English](../README.md) | **中文** 🚀 Demo | 📖 Docs | 📢 HN Discussion | 𝕏 Follow on X -https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 +[![Watch the demo](https://page-agent.github.io/assets/readme/poster.jpg)](https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2) --- @@ -26,6 +35,7 @@ https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 - **📖 基于文本的 DOM 操作** - 无需截图，无需多模态模型或特殊权限 - **🧠 自备 LLM** + - 支持多数主流模型，包括本地部署模型。参见[支持的模型](https://alibaba.github.io/page-agent/docs/features/models)。 - 🐙 可选的 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension)，支持跨页面任务 - [MCP Server (Beta)](https://alibaba.github.io/page-agent/docs/features/mcp-server) @@ -44,7 +54,7 @@ https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2 通过我们免费的 Demo LLM 快速体验 PageAgent： ```html - + ``` > **⚠️ 仅用于技术评估。** 该 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)。 @@ -85,6 +95,8 @@ await agent.execute('点击登录按钮') 我们不接受未经实质性人类参与、完全由 Bot 或 Agent 自动生成的代码。 +用 PageAgent 做了有趣的东西？欢迎到 [Show and Tell](https://github.com/alibaba/page-agent/discussions/categories/show-and-tell) 分享。🙌 + ## 👏 声明与致谢 本项目基于 **[`browser-use`](https://github.com/browser-use/browser-use)** 的优秀工作构建。 @@ -107,6 +119,4 @@ this project possible. [MIT License](../LICENSE) ---- - **⭐ 如果觉得 PageAgent 有用或有趣，请给项目点个星！**