docs: update all README files (web-infra-dev#2809)

* docs: update all README files

* docs: add ch README

* chore: add s

* chore: fix dot

* docs: update

---------

Co-authored-by: Belinda Cao <[email protected]>

README.md

@@ -1,41 +1,55 @@
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
+<p align="center">
+  <img src="https://img.shields.io/npm/v/@modern-js/core?style=flat-square&color=00a8f0" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/@modern-js/core.svg?style=flat-square&color=00a8f0" alt="downloads" />
+  <img src="https://img.shields.io/npm/l/@modern-js/core?style=flat-square&color=00a8f0" alt="License" />
+</p>
 
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+English | [简体中文](./README.zh-CN.md)
 
 ## Getting Started
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Contributing
+## Documentation
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
-## Credits
+## Ecosystem
+
+The following solutions are available within the Modern.js ecosystem:
 
-Some implementation of Modern.js are modified from existing projects, such as create-react-app, vite, wmr and jest. Thanks for them.
+- 🦄 [Modern.js Module](https://modernjs.dev/module-tools/en/): A powerful solution for npm package development.
+- 🐧 [Modern.js Builder](https://modernjs.dev/builder/en/): A Build Engine for web development.
+- 🐟 [Garfish](https://github.com/modern-js-dev/garfish): A powerful micro front-end framework.
+- 🐈 [Reduck](https://github.com/modern-js-dev/reduck): A redux-based state management library.
+
+## Contributing
 
-- Testing: Run jest by node.js API, some code modified from [jest-cli](https://github.com/facebook/jest/blob/fdc74af37235354e077edeeee8aa2d1a4a863032/packages/jest-cli/src/cli/index.ts#L21).
+> New contributors welcome!
+
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## Credits
 
-- esbuild-webpack-plugin: modified from [esbuild-webpack-plugin](https://github.com/sorrycc/esbuild-webpack-plugin) and support webpack 5.
+Some implementations of Modern.js are modified from existing projects, such as [create-react-app](https://github.com/facebook/create-react-app), [jest](https://github.com/facebook/jest) and [bundle-require](https://github.com/egoist/bundle-require). Thanks for them.
 
-- Webpack messages formatter and module scopes plugin: modified from [react-dev-utils](https://github.com/facebook/create-react-app/tree/main/packages/react-dev-utils) and refactored to TypeScript.
+- `@modern-js/bundle-require`: is modified from [bundle-require](https://github.com/egoist/bundle-require).
+- `@modern-js/plugin`: the hooks API is references from [farrow-pipeline](https://github.com/farrow-js/farrow/tree/master/packages/farrow-pipeline).
+- `@modern-js/builder`: the moduleScope and fileSize plugins are references from [create-react-app](https://github.com/facebook/create-react-app).
+- `@modern-js/plugin-testing`: the jest runner is references from [jest-cli](https://github.com/facebook/jest/blob/fdc74af37235354e077edeeee8aa2d1a4a863032/packages/jest-cli/src/cli/index.ts#L21).
+- `@modern-js/doc-tools`: some styles are are references from [vitepress](https://github.com/vuejs/vitepress).
 
-- bundle-require: modified from [bundle-require](https://github.com/egoist/bundle-require).
+## License
 
-- farrow-pipeline: modified from [farrow-pipeline](https://github.com/farrow-js/farrow/tree/master/packages/farrow-pipeline).
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

README.zh-CN.md

@@ -0,0 +1,55 @@
+<p align="center">
+  <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
+</p>
+
+<h1 align="center">Modern.js</h1>
+
+<p align="center">
+  基于 React 的渐进式现代 Web 开发框架。
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/npm/v/@modern-js/core?style=flat-square&color=00a8f0" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/@modern-js/core.svg?style=flat-square&color=00a8f0" alt="downloads" />
+  <img src="https://img.shields.io/npm/l/@modern-js/core?style=flat-square&color=00a8f0" alt="License" />
+</p>
+
+[English](./README.md) | 简体中文
+
+## 快速上手
+
+请参考 [快速上手](https://modernjs.dev/guides/get-started/quick-start) 来开始使用 Modern.js。
+
+## 文档
+
+- [中文文档](https://modernjs.dev)
+- [英文文档](https://modernjs.dev/en/)
+
+## 生态
+
+Modern.js 生态提供了以下解决方案：
+
+- 🦄 [Modern.js Module](https://modernjs.dev/module-tools): 简单、强大、高性能的现代化 npm 包开发方案。
+- 🐧 [Modern.js Builder](https://modernjs.dev/builder): 一个面向 Web 开发场景的构建引擎。
+- 🐟 [Garfish](https://github.com/modern-js-dev/garfish): 一站式微前端解决方案。
+- 🐈 [Reduck](https://github.com/modern-js-dev/reduck): 一个基于 Redux 的状态管理库。
+
+## 参与贡献
+
+> 欢迎参与 Modern.js 贡献！
+
+请阅读 [贡献指南](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md) 来共同参与 Modern.js 的建设。
+
+## Credits
+
+Modern.js 中的部分代码是参考社区中的其他项目实现的，比如 [create-react-app](https://github.com/facebook/create-react-app)，[jest](https://github.com/facebook/jest) 和 [bundle-require](https://github.com/egoist/bundle-require) 等，感谢这些项目：
+
+- `@modern-js/bundle-require`: 修改自 [bundle-require](https://github.com/egoist/bundle-require).
+- `@modern-js/plugin`: hook API 的实现参考了 [farrow-pipeline](https://github.com/farrow-js/farrow/tree/master/packages/farrow-pipeline).
+- `@modern-js/builder`: moduleScope 和 fileSize 插件参考了 [create-react-app](https://github.com/facebook/create-react-app)。
+- `@modern-js/plugin-testing`: jest runner 参考了 [jest-cli](https://github.com/facebook/jest/blob/fdc74af37235354e077edeeee8aa2d1a4a863032/packages/jest-cli/src/cli/index.ts#L21).
+- `@modern-js/doc-tools`: 部分样式参考了 [vitepress](https://github.com/vuejs/vitepress)。
+
+## License
+
+Modern.js 项目基于 [MIT 协议](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE)，请自由地享受和参与开源。

packages/builder/builder-doc/docs/en/guide/introduction.mdx

@@ -1,6 +1,6 @@
 # Introduction
 
-Modern.js Builder is **a Build Engine for web development.**.
+Modern.js Builder is **a Build Engine for web development**.
 
 With the growing of the front-end ecosystem, more and more build tools and plugins are created. For most developers, the configuration and dependencies required to build a web application have become complex; the cost of finding best practices for developers has also risen.
 

packages/cli/babel-preset-app/README.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

packages/cli/babel-preset-base/readme.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

packages/cli/babel-preset-lib/README.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

packages/cli/babel-preset-module/README.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

packages/cli/core/README.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

packages/cli/plugin-bff/README.md

@@ -1,29 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
-<p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
   A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
+## Getting Started
 
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).