Skip to content

Commit

Permalink
docs: enhance the feature introduction in the documentation. (#326)
Browse files Browse the repository at this point in the history
  • Loading branch information
zhoushaw authored Jan 25, 2025
1 parent 4b0aae2 commit 1fb67b0
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 4 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ English | [简体中文](./README.zh.md)
</div>

<p align="center">
Joyful UI Automation
Assign AI as your browser operator.
</p>

<p align="center">
Expand All @@ -22,7 +22,8 @@ English | [简体中文](./README.zh.md)
<a href="https://x.com/midscene_ai"><img src="https://img.shields.io/twitter/follow/midscene_ai?style=flat-square" alt="twitter" /></a>
</p>

Midscene.js is an AI-powered automation SDK with the abilities to control the page, perform assertions and extract data in JSON format using natural language.
Midscene.js lets AI be your browser operator 🤖.Just describe what you want to do in natural language, and it will help you operate web pages, validate content, and extract data. Whether you want a quick experience or deep development, you can get started easily.


## Showcases

Expand Down Expand Up @@ -84,6 +85,26 @@ There are so many UI automation tools out there, and each one seems to be all-po
* [Follow us on X](https://x.com/midscene_ai)
* [Lark Group](https://applink.larkoffice.com/client/chat/chatter/add_by_link?link_token=291q2b25-e913-411a-8c51-191e59aab14d)


## Citation

If you use Midscene.js in your research or project, please cite:

@software{Midscene.js,
author = {Zhou xiao, Yutao},
title = {Midscene.js: Assign AI as your web operator.},
year = {2025},
publisher = {GitHub},
url = {https://github.com/web-infra-dev/midscene}
}


## 📝 License

Midscene.js is [MIT licensed](https://github.com/web-infra-dev/midscene/blob/main/LICENSE).

---

<div align="center">
If this project helps you or inspires you, please give us a ⭐️
</div>
22 changes: 20 additions & 2 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
</div>

<p align="center">
AI 加持,更愉悦的 UI 自动化
AI 成为你的浏览器操作员
</p>

<p align="center">
Expand All @@ -22,7 +22,7 @@
<a href="https://x.com/midscene_ai"><img src="https://img.shields.io/twitter/follow/midscene_ai" alt="twitter" /></a>
</p>

Midscene.js 是一个由 AI 驱动的自动化 SDK,能够使用自然语言对网页进行操作、验证,并提取 JSON 格式的数据
Midscene.js AI 成为你的浏览器操作员 🤖。只需用自然语言描述你想做什么,它就能帮你操作网页、验证内容,并提取数据。无论你是想快速体验还是深度开发,都可以轻松上手。如果您在项目中使用了 Midscene.js,可以加入我们的 [社区](https://github.com/web-infra-dev/midscene?tab=readme-ov-file#-community) 来与我们交流和分享

## 案例

Expand Down Expand Up @@ -88,7 +88,25 @@ Midscene.js 是一个由 AI 驱动的自动化 SDK,能够使用自然语言对

<img src="https://github.com/user-attachments/assets/211b05c9-3ccd-4f52-b798-f3a7f51330ed" alt="lark group link" width="300" />

## 引用

如果您在研究或项目中使用了 Midscene.js,请引用:

@software{Midscene.js,
author = {Zhou xiao, Yutao},
title = {Midscene.js: Assign AI as your web operator.},
year = {2025},
publisher = {GitHub},
url = {https://github.com/web-infra-dev/midscene}
}

## 📝 授权许可

Midscene.js 遵循 [MIT 许可协议](https://github.com/web-infra-dev/midscene/blob/main/LICENSE)


---

<div align="center">
如果本项目对你有帮助或启发,请给我们一个 ⭐️
</div>

0 comments on commit 1fb67b0

Please sign in to comment.