chore: update readme

zx119 · May 16, 2020 · 1dc842f · 1dc842f
1 parent 15629b5
commit 1dc842f
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 32 deletions.
diff --git a/README.zh-CN.md → README.en-US.md b/README.zh-CN.md → README.en-US.md
@@ -1,4 +1,4 @@
-[English](./README.md) | 简体中文
+English | [简体中文](./README.md)
 
 
 ![](https://img.alicdn.com/tfs/TB1HdniCSf2gK0jSZFPXXXsopXa-1000-353.png)
@@ -24,25 +24,25 @@
   </a>
 </p>
 
-Midway FaaS 是一个用于构建 Node.js 云函数的 Serverless 框架，可以帮您在云原生时代更专注于产品开发，降低维护成本。
+Midway FaaS is the Serverless framework used to build Node.js cloud functions. Helps you significantly reduce maintenance costs and focus more on product development in the cloud-native era.
 
-- **跨云厂商**：一份代码可以在多个云平台上快速部署，你不用担心产品被捆绑在一个云厂商上。
-- **代码重用**：通过框架的依赖注入能力，代码逻辑的每个部分都是自然可复用的，可以快速轻松组合生成复杂的应用。
-- **传统迁移**：通过框架的运行时扩展能力，可以将传统应用如 Egg.js、Koa、Express.js 等无缝迁移到各个云厂商。
+- **Cross-cloud vendor**: One code can be deployed quickly across multiple cloud platforms, so you don't have to worry about your product being tied to a cloud vendor.
+- **Code reuse**: Through the framework's dependency injection capability, each part of the logical unit is naturally reusable and can be quickly and easily combined to generate complex applications.
+- **Traditional Migration**: Through the framework's runtime scalability, traditional applications such as Egg.js, Koa, Express.js and others can be seamlessly migrated to the cloud functions of various cloud vendors.
 
-## 文档
+## Document
 
-- 文档 [中文](https://www.yuque.com/midwayjs/faas)
+- Guide [中文](https://www.yuque.com/midwayjs/faas) and [English](https://www.yuque.com/midwayjs/faas/quick_start?translate=en)
 
-## 生态体系
+## Ecology
 
 |    Project         |    Version                                |   Description       |
 |----------------|-----------------------------------------|-----------|
-| [midway-faas] | [![faas-status]][faas-package] |基于依赖注入适配多云平台的 Serverless 开发框架|
-| [runtime-engine] | [![runtime-engine-status]][runtime-engine-package] |通用的基础 Serverless 运行时|
-| [serverless-fc-starter] | [![serverless-fc-starter-status]][serverless-fc-starter-package] |阿里云 FC 函数启动器|
-| [serverless-scf-starter] | [![serverless-scf-starter-status]][serverless-scf-starter-package] |腾讯云 SCF 函数启动器|
-| [midway] | [![midway-status]][midway-package] |基于依赖注入面向未来的 Web 开发框架|
+| [midway-faas] | [![faas-status]][faas-package] |A serverless framework based on dependency injection for adaptive multi-cloud platforms|
+| [runtime-engine] | [![runtime-engine-status]][runtime-engine-package] |A base serverless runtime|
+| [serverless-fc-starter] | [![serverless-fc-starter-status]][serverless-fc-starter-package] |Aliyun FC Function Launcher|
+| [serverless-scf-starter] | [![serverless-scf-starter-status]][serverless-scf-starter-package] |Tencent Cloud SCF Function Launcher|
+| [midway] | [![midway-status]][midway-package] |A future-proof web framework base on dependency injection |
 
 
 [midway-faas]: https://github.com/midwayjs/midway-faas
@@ -64,11 +64,11 @@ Midway FaaS 是一个用于构建 Node.js 云函数的 Serverless 框架，可
 [serverless-fc-starter-package]: https://npmjs.com/package/@midwayjs/serverless-fc-starter
 [serverless-scf-starter-package]: https://npmjs.com/package/@midwayjs/serverless-scf-starter
 
-## 社区合作伙伴
+## Community partners
 
 - [icejs](https://ice.work/)
 - [ykfe/ssr](https://github.com/ykfe/ssr/)
 
-## 协议
+## License
 
-Midway FaaS 基于 [MIT licensed](./LICENSE) 协议开发.
+Midway FaaS is [MIT licensed](./LICENSE).
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-English | [简体中文](./README.zh-CN.md)
+[English](./README.en-US.md) | 简体中文
 
 
 ![](https://img.alicdn.com/tfs/TB1HdniCSf2gK0jSZFPXXXsopXa-1000-353.png)
@@ -24,25 +24,40 @@ English | [简体中文](./README.zh-CN.md)
   </a>
 </p>
 
-Midway FaaS is the Serverless framework used to build Node.js cloud functions. Helps you significantly reduce maintenance costs and focus more on product development in the cloud-native era.
+Midway FaaS 是一个用于构建 Node.js 云函数的 Serverless 框架，可以帮您在云原生时代更专注于产品开发，降低维护成本。
 
-- **Cross-cloud vendor**: One code can be deployed quickly across multiple cloud platforms, so you don't have to worry about your product being tied to a cloud vendor.
-- **Code reuse**: Through the framework's dependency injection capability, each part of the logical unit is naturally reusable and can be quickly and easily combined to generate complex applications.
-- **Traditional Migration**: Through the framework's runtime scalability, traditional applications such as Egg.js, Koa, Express.js and others can be seamlessly migrated to the cloud functions of various cloud vendors.
+- **跨云厂商**：一份代码可以在多个云平台上快速部署，你不用担心产品被捆绑在一个云厂商上。
+- **代码重用**：通过框架的依赖注入能力，代码逻辑的每个部分都是自然可复用的，可以快速轻松组合生成复杂的应用。
+- **传统迁移**：通过框架的运行时扩展能力，可以将传统应用如 Egg.js、Koa、Express.js 等无缝迁移到各个云厂商。
 
-## Document
+## 文档
 
-- Guide [中文](https://www.yuque.com/midwayjs/faas) and [English](https://www.yuque.com/midwayjs/faas/quick_start?translate=en)
+- 文档 [中文](https://www.yuque.com/midwayjs/faas)
 
-## Ecology
+## 示例
+
+当前已接入以下前端一体化示例。
+
+|<img alt="React" src="https://user-images.githubusercontent.com/677114/42611693-f921fc7c-85c9-11e8-8de1-6d6013b92f69.png" width="48">| <img alt="Vue" src="https://user-images.githubusercontent.com/677114/42611543-44ef4502-85c9-11e8-9ef9-e9f98477c646.png" width="48">
+| :---: | :---: | :---: |
+| [React](https://www.yuque.com/midwayjs/faas/faas_with_react) | [Vue](https://www.yuque.com/midwayjs/faas/faas_with_vue) |
+
+## 加入社区
+
+扫码加入即刻交流与反馈：
+
+
+<img alt="Join the chat at dingtalk" src="https://user-images.githubusercontent.com/418820/82108754-60371300-9763-11ea-88f4-fc59c743ea23.png" width="200">
+
+## 生态体系
 
 |    Project         |    Version                                |   Description       |
 |----------------|-----------------------------------------|-----------|
-| [midway-faas] | [![faas-status]][faas-package] |A serverless framework based on dependency injection for adaptive multi-cloud platforms|
-| [runtime-engine] | [![runtime-engine-status]][runtime-engine-package] |A base serverless runtime|
-| [serverless-fc-starter] | [![serverless-fc-starter-status]][serverless-fc-starter-package] |Aliyun FC Function Launcher|
-| [serverless-scf-starter] | [![serverless-scf-starter-status]][serverless-scf-starter-package] |Tencent Cloud SCF Function Launcher|
-| [midway] | [![midway-status]][midway-package] |A future-proof web framework base on dependency injection |
+| [midway-faas] | [![faas-status]][faas-package] |基于依赖注入适配多云平台的 Serverless 开发框架|
+| [runtime-engine] | [![runtime-engine-status]][runtime-engine-package] |通用的基础 Serverless 运行时|
+| [serverless-fc-starter] | [![serverless-fc-starter-status]][serverless-fc-starter-package] |阿里云 FC 函数启动器|
+| [serverless-scf-starter] | [![serverless-scf-starter-status]][serverless-scf-starter-package] |腾讯云 SCF 函数启动器|
+| [midway] | [![midway-status]][midway-package] |基于依赖注入面向未来的 Web 开发框架|
 
 
 [midway-faas]: https://github.com/midwayjs/midway-faas
@@ -64,11 +79,16 @@ Midway FaaS is the Serverless framework used to build Node.js cloud functions. H
 [serverless-fc-starter-package]: https://npmjs.com/package/@midwayjs/serverless-fc-starter
 [serverless-scf-starter-package]: https://npmjs.com/package/@midwayjs/serverless-scf-starter
 
-## Community partners
+
+## 社区合作伙伴
 
 - [icejs](https://ice.work/)
 - [ykfe/ssr](https://github.com/ykfe/ssr/)
 
-## License
+## 协议
+
+Midway FaaS 基于 [MIT licensed](./LICENSE) 协议开发.
+
+## About
 
-Midway FaaS is [MIT licensed](./LICENSE).
+[Alibaba Open Source](https://opensource.alibaba.com/)