From a47aedaf7bcfb9aab255ce5f69a12c7fa379791f Mon Sep 17 00:00:00 2001 From: yutao Date: Fri, 2 Aug 2024 17:06:52 +0800 Subject: [PATCH] feat: update readme --- LICENSE | 21 +++++++++++++++++++ README.ch.md | 25 ----------------------- README.md | 41 ++++++++++++++++++++++++++------------ README.zh.md | 28 ++++++++++++++++++++++++++ apps/site/docs/zh/index.md | 24 +++++++++++----------- 5 files changed, 89 insertions(+), 50 deletions(-) create mode 100644 LICENSE delete mode 100644 README.ch.md create mode 100644 README.zh.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..53b8b6205 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021-present MidScene.js + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.ch.md b/README.ch.md deleted file mode 100644 index d9abb94b4..000000000 --- a/README.ch.md +++ /dev/null @@ -1,25 +0,0 @@ -

- MidScene.js -

- -
- -[English](./README.md) | 简体中文 - -
- - -# MidScene.js - -欢迎使用 **Midscene**！这是一个全新的 AI 自动化页面操作和信息提取的框架，利用自然语言（NLQ）和人工智能（AI）技术，简化了复杂的数据查询和用户界面交互。通过 Midscene，您可以轻松地使用自然语言操作页面、定位元素、生成自定义数据结构，并自动分配类型，所有这些都无需进行任何自定义训练。 - -## 特性 ✨ - -- **自然语言页面控制**：使用自然语言操作页面，包括鼠标点击、滚动、键盘输入等人类行为 🗣️💻 -- **JSON 响应**：通过提示 AI 生成所需的数据结构，确保 JSON 结构和值的可预测性。📊📋 -- **TypeScript 友好**：自动分配类型，使用点表示法轻松访问数据。📝🔍 -- **可视化工具**：使用可视化工具轻松调试提示和推理过程。🛠️👀 -- **全新体验**：享受全新的自动化开发世界。🌟🚀 -- **即用型 AI 模型**：使用 GPT-4o，无需进行任何自定义训练。🤖🔧 - - diff --git a/README.md b/README.md index 311b8ad87..3ed8f45d4 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,37 @@

-
+

MidScene.js

+
English | [简体中文](README.zh.md)
-English | [简体中文](README.ch.md) - -
+

+ Joyful UI Automation +

-# MidScene.js +

+ npm version + downloads + License +

-Welcome to **Midscene**! This is a brand-new framework for AI automated page operations and information extraction, leveraging Natural Language Query (NLQ) and Artificial Intelligence (AI) technologies to simplify complex data queries and user interface interactions. With Midscene, you can easily operate pages, locate elements, generate custom data structures, and automatically assign types using natural language, all without any custom training. +MidScene.js is an AI-powered automation SDK can control the page, perform assertions, and extract data in JSON format using natural language. ## Features ✨ -- **Natural Language Page Control**: Operate pages using natural language, including actions like clicking and typing 🗣️💻 -- **Natural Language Query**: Locate page elements using natural language, eliminating the need for DOM selectors 🔍🗂️ -- **JSON Responses**: Prompt AI to generate the required data structures, ensuring the predictability of JSON structures and values 📊📋 -- **TypeScript Friendly**: Automatically assign types and access data easily using dot notation 📝🔍 -- **Visualization Tools**: Easily debug prompts and reasoning processes with visualization tools 🛠️👀 -- **New Experience**: Enjoy a new world of automated development 🌟🚀 -- **Ready-to-Use AI Models**: Utilize GPT-4o without any custom training 🤖🔧 +- **Natural Language Interaction**: Describe the steps and let MidScene plan and control the user interface for you 👆 +- **Understand UI, Answer in JSON**: Provide prompts regarding the desired data format, and then receive the expected response in JSON format. 🔍 +- **Intuitive Assertion**: Make assertions in natural language. It’s all based on AI understanding. 🤔 +- **Out-of-box LLM**: It is fine to use public multimodal LLMs like GPT-4o. There is no need for any custom training. 🪓 +- **Visualization**: With our visualization tool, you can easily understand and debug the whole process. 🎞️ +- **Brand New Experience!**: Experience a whole new world of automation development. Enjoy! 🔥 + +## Resources + +* [Home Page: http://midscenejs.com](https://midscenejs.com/) +* [Quick Start](https://midscenejs.com/docs/getting-started/quick-start.html) +* [API Reference](https://midscenejs.com/docs/usage/API.html) +* [Visualization Tool](https://midscenejs.com/visualization/index.html) + +## License + +MidScene.js is [MIT licensed](https://github.com/web-infra-dev/midscene/blob/main/LICENSE). diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 000000000..72acff2cf --- /dev/null +++ b/README.zh.md @@ -0,0 +1,28 @@ +

+ MidScene.js +

+ +

MidScene.js

+
English | [简体中文](README.zh.md)
+ +

+ Joyful UI Automation +

+ +

+ npm version + downloads + License +

+ + +MidScene.js 是一个由 AI 驱动的自动化 SDK，能够使用自然语言对网页进行操作、验证，并提取 JSON 格式的数据。 + +## 特性 ✨ + +- **自然语言互动**：只需描述你的步骤，MidScene 会为你规划和操作用户界面 👆 +- **理解UI、JSON格式回答**：你可以提出关于数据格式的要求，然后得到 JSON 格式的预期回应。 🔍 +- **直观断言**：用自然语言表达你的断言，AI 会理解并处理。 🤔 +- **开箱即用的LLM**：使用公开的多模态语言模型（ 如GPT-4o ），无需任何定制训练。 🪓 +- **可视化**：通过我们的可视化工具，你可以轻松理解和调试整个过程。 🎞️ +- **全新体验**：体验全新的自动化开发世界，尽情享受吧！🔥 diff --git a/apps/site/docs/zh/index.md b/apps/site/docs/zh/index.md index 6fa8a5600..82d353e41 100644 --- a/apps/site/docs/zh/index.md +++ b/apps/site/docs/zh/index.md @@ -19,22 +19,22 @@ hero: alt: MidScene Logo features: - - title: 自然语言控制界面 - details: 描述操作步骤，MidScene 为你自动操控界面 + - title: 自然语言互动 + details: 只需描述你的步骤，MidScene 会为你规划和操作用户界面 icon: 👆 - - title: 理解界面，提取数据 - details: 描述你需要的数据和格式，由 MidScene 提取并生成 JSON + - title: 理解UI、JSON格式回答 + details: 你可以提出关于数据格式的要求，然后得到 JSON 格式的预期回应 icon: 🔍 - - title: 描述并断言 - details: 使用自然语言对界面进行断言 + - title: 直观断言 + details: 用自然语言表达你的断言，AI 会理解并处理 icon: 🤔 - - title: 开箱即用的模型 - details: 无需自行训练模型，可以直接使用 GPT-4o + - title: 开箱即用的LLM + details: 使用公开的多模态语言模型（如GPT-4o），无需任何定制训练 icon: 🪓 - - title: 可视化工具 - details: 使用配套的可视化工具，清晰掌握 SDK 的每个步骤 + - title: 可视化 + details: 通过我们的可视化工具，你可以轻松理解和调试整个过程 icon: 🎞️ - - title: 前所未有的新体验! - details: 更自然、更易于维护的 UI 自动化编写体验。试试吧！ + - title: 全新体验 + details: 体验全新的自动化开发模式，尽情享受吧！ icon: 🔥 --- \ No newline at end of file