docs: update readme for the 3.0 version (#3642)

opensumi · May 10, 2024 · 367a75e · 367a75e
1 parent db3e1e5
commit 367a75e
Show file tree

Hide file tree

Showing 2 changed files with 128 additions and 56 deletions.
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -2,16 +2,23 @@
  <a href="https://github.com/opensumi/core"><img src="https://img.alicdn.com/imgextra/i2/O1CN01dqjQei1tpbj9z9VPH_!!6000000005951-55-tps-87-78.svg" width="150" /></a>
 </p>
 
+<h1 align="center">OpenSumi</h1>
+
+<p align="center">一款帮助你快速搭建 AI 原生 IDE 产品的底层框架。</p>
+
 <div align="center">
 
 [![CI][ci-image]][ci-url]
 [![E2E][e2e-image]][e2e-url]
-[![NPM Version][npm-image]][npm-url]
-[![NPM downloads][download-image]][download-url]
 [![Test Coverage][test-image]][test-url]
-[![CLA assistant][cla-image]][cla-url]
-[![License][license-image]][license-url]
-[![Discussions][discussions-image]][discussions-url]
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![Issues need help][help-wanted-image]][help-wanted-url]
+
+[![Discussions][discussions-image]][discussions-url] [![CLA assistant][cla-image]][cla-url] [![License][license-image]][license-url]
+
+[![NPM Version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
+
+[![Open in CodeBlitz][codeblitz-image]][codeblitz-url]
 
 [ci-image]: https://github.com/opensumi/core/actions/workflows/ci.yml/badge.svg
 [ci-url]: https://github.com/opensumi/core/actions/workflows/ci.yml
@@ -29,18 +36,28 @@
 [cla-url]: https://cla-assistant.io/opensumi/core
 [test-image]: https://codecov.io/gh/opensumi/core/branch/main/graph/badge.svg?token=07JAPLU957
 [test-url]: https://codecov.io/gh/opensumi/core
+[codeblitz-image]: https://img.shields.io/badge/Ant_Codespaces-Open_in_CodeBlitz-1677ff
+[codeblitz-url]: https://codeblitz.cloud.alipay.com/github/opensumi/core
+[github-issues-url]: https://github.com/opensumi/core/issues
+[help-wanted-image]: https://flat.badgen.net/github/label-issues/opensumi/core/🤔%20help%20wanted/open
+[help-wanted-url]: https://github.com/opensumi/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22🤔+help+wanted%22
+
+[Changelog](./CHANGELOG-zh_CN.md) · [Report Bug][github-issues-url] · [Request Feature][github-issues-url] · [English](./README.md) · 中文
 
 </div>
 
-<h1 align="center">OpenSumi</h1>
+![perview](https://img.alicdn.com/imgextra/i3/O1CN01UUnvG21foKD7RAw9n_!!6000000004053-2-tps-2400-721.png)
 
-<p align="center">一款帮助你快速搭建 CloudIDE 及 桌面端 IDE 产品的底层框架。</p>
+## 🌟 起步项目
 
-![perview](https://img.alicdn.com/imgextra/i3/O1CN01bDhxUy1RtuCfQ1fcI_!!6000000002170-2-tps-2844-1796.png)
+我们提供了一些示例项目帮助你快速搭建你的 IDE 项目产品
 
-[English](./README.md) | 简体中文
+- [Cloud IDE](https://github.com/opensumi/ide-startup)
+- [Desktop IDE - based on the Electron](https://github.com/opensumi/ide-electron)
+- [Lite Web IDE - pure web IDE based on the Browser](https://github.com/opensumi/ide-startup-lite)
+- [The Mini-App liked IDE](https://github.com/opensumi/app-desktop)
 
-## ⚡️ 快速开始
+## ⚡️ 如何开发
 
 由于国内网络访问的问题，部分包的下载安装都会比较缓慢，建议在开始前将你的 npm 镜像切换至国内 taobao 镜像地址，或安装一个 npm 镜像切换工具用于快速切换，如 [nrm](https://www.npmjs.com/package/nrm), 手动设置方式如下：
 
@@ -63,15 +80,6 @@ $ MY_WORKSPACE={local_path} yarn run start
 
 通常情况下，你可能还会遇到一些系统级别的环境依赖问题，你可以访问 [开发环境准备](./CONTRIBUTING-zh_CN.md#开发环境准备) 查看如何安装对应环境依赖。
 
-## 🌟 起步项目
-
-我们提供了一些示例项目帮助你快速搭建你的 IDE 项目产品
-
-- [Cloud IDE](https://github.com/opensumi/ide-startup)
-- [Desktop IDE - based on the Electron](https://github.com/opensumi/ide-electron)
-- [Lite Web IDE - pure web IDE based on the Browser](https://github.com/opensumi/ide-startup-lite)
-- [The Mini-App liked IDE](https://github.com/opensumi/app-desktop)
-
 ## 📕 文档
 
 请访问 [opensumi.com](https://opensumi.com/zh)
@@ -98,18 +106,47 @@ $ MY_WORKSPACE={local_path} yarn run start
 
 如果你希望通过即时通讯工具（如微信、钉钉）交流，欢迎前往我们的 [中文社区](https://opensumi.com/zh/community) 页面获取最新二维码信息。
 
+## ✨ 贡献者
+
+加入我们，一起构建更好用的 OpenSumi！
+
+<table>
+<tr>
+ <td>
+ <a href="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors?repo_id=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=dark" width="280">
+  <img alt="Top Contributors of ant-design/ant-design - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=light" width="280">
+  </picture>
+ </a>
+ </td>
+ <td rowspan="2">
+ <a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=dark" width="655" height="auto">
+  <img alt="Performance Stats of ant-design/ant-design - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=light" width="655" height="auto">
+  </picture>
+ </a>
+ </td>
+</tr>
+<tr>
+ <td>
+ <a href="https://next.ossinsight.io/widgets/official/compose-org-active-contributors?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828&image_size=2x3&color_scheme=dark" width="273" height="auto">
+  <img alt="Active participants of opensumi - past 28 days" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828&image_size=2x3&color_scheme=light" width="273" height="auto">
+  </picture>
+ </a>
+ </td>
+</tr>
+</table>
+
+在开始之前，请花点时间查看我们的[贡献指南](./CONTRIBUTING-zh_CN.md)。欢迎通过 [Pull Requests](https://github.com/opensumi/core/pulls) 或 [GitHub Issues](https://github.com/opensumi/core/issues) 分享您的想法。
+
 ## 📃 协议
 
 Copyright (c) 2019-present Alibaba Group Holding Limited, Ant Group Co. Ltd.
 
 本项目采用 [MIT](LICENSE) 协议。
 
 同时，该项目也包含部分基于其他开源协议下的第三方代码，详细内容请查看 [NOTICE.md](./NOTICE.md) 文件。
-
-## ✨ 贡献者
-
-❤️ 感谢你们对项目的贡献!
-
-<a href="https://github.com/opensumi/core/graphs/contributors">
- <img width="800" src="https://contrib.rocks/image?repo=opensumi/core" />
-</a>
diff --git a/README.md b/README.md
@@ -2,16 +2,22 @@
  <a href="https://github.com/opensumi/core"><img src="https://img.alicdn.com/imgextra/i2/O1CN01dqjQei1tpbj9z9VPH_!!6000000005951-55-tps-87-78.svg" width="150" /></a>
 </p>
 
+<h1 align="center">OpenSumi</h1>
+
+<p align="center">A framework helps you quickly build AI Native IDE products.</p>
+
 <div align="center">
 
 [![CI][ci-image]][ci-url]
 [![E2E][e2e-image]][e2e-url]
-[![NPM Version][npm-image]][npm-url]
-[![NPM downloads][download-image]][download-url]
 [![Test Coverage][test-image]][test-url]
-[![CLA assistant][cla-image]][cla-url]
-[![License][license-image]][license-url]
-[![Discussions][discussions-image]][discussions-url]
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
+[![Issues need help][help-wanted-image]][help-wanted-url]
+
+[![Discussions][discussions-image]][discussions-url] [![CLA assistant][cla-image]][cla-url] [![License][license-image]][license-url]
+
+[![NPM Version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url]
+
 [![Open in CodeBlitz][codeblitz-image]][codeblitz-url]
 
 [ci-image]: https://github.com/opensumi/core/actions/workflows/ci.yml/badge.svg
@@ -32,17 +38,27 @@
 [test-url]: https://codecov.io/gh/opensumi/core
 [codeblitz-image]: https://img.shields.io/badge/Ant_Codespaces-Open_in_CodeBlitz-1677ff
 [codeblitz-url]: https://codeblitz.cloud.alipay.com/github/opensumi/core
+[github-issues-url]: https://github.com/opensumi/core/issues
+[help-wanted-image]: https://flat.badgen.net/github/label-issues/opensumi/core/🤔%20help%20wanted/open
+[help-wanted-url]: https://github.com/opensumi/core/issues?q=is%3Aopen+is%3Aissue+label%3A%22🤔+help+wanted%22
+
+[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-url] · [Request Feature][github-issues-url] · English · [中文](./README-zh_CN.md)
 
 </div>
-<h1 align="center">OpenSumi</h1>
 
-<p align="center">A framework helps you quickly build Cloud or Desktop IDE products.</p>
+![perview](https://img.alicdn.com/imgextra/i3/O1CN01UUnvG21foKD7RAw9n_!!6000000004053-2-tps-2400-721.png)
 
-![perview](https://img.alicdn.com/imgextra/i2/O1CN018JorOL1oWlLmbzGv0_!!6000000005233-2-tps-2844-1796.png)
+## 🌟 Getting Started
 
-English | [简体中文](./README-zh_CN.md)
+Here you can find some of our example projects and templates:
+
+- [Cloud IDE](https://github.com/opensumi/ide-startup)
+- [Desktop IDE - based on the Electron](https://github.com/opensumi/ide-electron)
+- [CodeBlitz - A pure web IDE Framework](https://github.com/opensumi/codeblitz)
+- [Lite Web IDE - A pure web IDE on the Browser](https://github.com/opensumi/ide-startup-lite)
+- [The Mini-App liked IDE](https://github.com/opensumi/app-desktop)
 
-## ⚡️ Quick Start
+## ⚡️ Development
 
 ```bash
 $ yarn install
@@ -59,16 +75,6 @@ $ MY_WORKSPACE={local_path} yarn run start
 
 Usually, you may still encounter some system-level environment dependencies. You can visit [Development Environment Preparation](./CONTRIBUTING.md#development-environment-preparation) to see how to install the corresponding environment dependencies.
 
-## 🌟 Getting Started
-
-Here you can find some of our example projects and templates:
-
-- [Cloud IDE](https://github.com/opensumi/ide-startup)
-- [Desktop IDE - based on the Electron](https://github.com/opensumi/ide-electron)
-- [CodeBlitz - A pure web IDE Framework](https://github.com/opensumi/codeblitz)
-- [Lite Web IDE - A pure web IDE on the Browser](https://github.com/opensumi/ide-startup-lite)
-- [The Mini-App liked IDE](https://github.com/opensumi/app-desktop)
-
 ## 📕 Documentation
 
 For complete documentation: [opensumi.com](https://opensumi.com)
@@ -79,7 +85,7 @@ You can see all the releasenotes and breaking changes here: [CHANGELOG.md](./CHA
 
 ## 🔥 Contributing
 
-Read through our [Contributing Guidelines](./CONTRIBUTING.md) to learn about our submission process, coding rules and more.
+Read through our [Contributing Guide](./CONTRIBUTING.md) to learn about our submission process, coding rules and more.
 
 ## 🙋‍♀️ Want to Help?
 
@@ -89,6 +95,43 @@ Want to report a bug, contribute some code, or improve documentation? Excellent!
 
 Go to our [issues](https://github.com/opensumi/core/issues) or [discussions](https://github.com/opensumi/core/discussions) to create a topic, it will be resolved as soon as we can.
 
+## ✨ Contributors
+
+Let's build a better OpenSumi together.
+
+<table>
+<tr>
+ <td>
+ <a href="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors?repo_id=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=dark" width="280">
+  <img alt="Top Contributors of ant-design/ant-design - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-recent-top-contributors/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=light" width="280">
+  </picture>
+ </a>
+ </td>
+ <td rowspan="2">
+ <a href="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats?repo_id=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=dark" width="655" height="auto">
+  <img alt="Performance Stats of ant-design/ant-design - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-last-28-days-stats/thumbnail.png?repo_id=429104828&image_size=auto&color_scheme=light" width="655" height="auto">
+  </picture>
+ </a>
+ </td>
+</tr>
+<tr>
+ <td>
+ <a href="https://next.ossinsight.io/widgets/official/compose-org-active-contributors?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828" target="_blank" style="display: block" align="center">
+  <picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828&image_size=2x3&color_scheme=dark" width="273" height="auto">
+  <img alt="Active participants of opensumi - past 28 days" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?period=past_28_days&activity=active&owner_id=90233428&repo_ids=429104828&image_size=2x3&color_scheme=light" width="273" height="auto">
+  </picture>
+ </a>
+ </td>
+</tr>
+</table>
+
+We warmly invite contributions from everyone. Before you get started, please take a moment to review our [Contributing Guide](./CONTRIBUTING.md). Feel free to share your ideas through [Pull Requests](https://github.com/opensumi/core/pulls) or [GitHub Issues](https://github.com/opensumi/core/issues).
+
 ## 📃 License
 
 Copyright (c) 2019-present Alibaba Group Holding Limited, Ant Group Co. Ltd.
@@ -98,11 +141,3 @@ Licensed under the [MIT](LICENSE) license.
 This project contains various third-party code under other open source licenses.
 
 See the [NOTICE.md](./NOTICE.md) file for more information.
-
-## ✨ Contributors
-
-❤️ Thanks goes to these wonderful people!
-
-<a href="https://github.com/opensumi/core/graphs/contributors">
- <img width="800" src="https://contrib.rocks/image?repo=opensumi/core" />
-</a>