From e7b18394698d33d7fb89ca2d766dcd0a21ba1796 Mon Sep 17 00:00:00 2001 From: bailicangdu <1264889788@qq.com> Date: Fri, 13 Aug 2021 19:22:52 +0800 Subject: [PATCH] docs: add docuention to readme --- README.md | 4 ++-- README.zh-cn.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d63e68f86..6a63caac3 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@

-English|[简体中文](https://github.com/micro-zoe/micro-app/blob/master/README.zh-cn.md)|[Discussions](https://github.com/micro-zoe/micro-app/discussions)|[Gitter](https://gitter.im/microzoe/micro-app) +English|[简体中文](https://github.com/micro-zoe/micro-app/blob/master/README.zh-cn.md)|[Documentation](https://zeroing.jd.com/micro-app/)|[Discussions](https://github.com/micro-zoe/micro-app/discussions)|[Gitter](https://gitter.im/microzoe/micro-app) # 📖Introduction micro-app is a micro front-end framework launched by JD Retail. It renders based on webcomponent-like and realizes the micro front-end from component thinking, it aiming to reduce the difficulty of getting started and improve work efficiency. @@ -124,7 +124,7 @@ Then micro front-end can be rendered normally, and the react micro application i The above lists the usage of react and Vue framework. They can be combined freely. For example, the base application is react, the micro application is Vue, or the base application is Vue, the micro application is react, or both the base application and the micro application are react and Vue. The micro-app has no restrictions on the front-end framework, and any framework can be used as a base application to embed any type of micro application of the framework. -More detailed configuration can be viewed [Official website document](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/start). +More detailed configuration can be viewed [Documentation](https://zeroing.jd.com/micro-app/docs.html#/zh-cn/start). # 🤝 Contribution If you're interested in this project, you're welcome to mention pull request, and also welcome your "Star" ^_^ diff --git a/README.zh-cn.md b/README.zh-cn.md index 83492d874..a4b3ca4cb 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -25,7 +25,7 @@

-[English](https://github.com/micro-zoe/micro-app)|简体中文|[讨论组](https://github.com/micro-zoe/micro-app/discussions)|[Gitter群聊](https://gitter.im/microzoe/micro-app) +[English](https://github.com/micro-zoe/micro-app)|简体中文|[官网文档](https://zeroing.jd.com/micro-app/)|[讨论组](https://github.com/micro-zoe/micro-app/discussions)|[Gitter群聊](https://gitter.im/microzoe/micro-app) # 📖简介 micro-app是京东零售推出的一款微前端框架,它基于类WebComponent进行渲染,从组件化的思维实现微前端,旨在降低上手难度、提升工作效率。它是目前接入微前端成本最低的框架,并且提供了JS沙箱、样式隔离、元素隔离、预加载、资源地址补全、插件系统、数据通信等一系列完善的功能。