浏览代码

docs: update

Sendya 6 年之前
父节点
当前提交
31b018e72f
共有 1 个文件被更改,包括 9 次插入5 次删除
  1. 9 5
      README.md

+ 9 - 5
README.md

@@ -1,3 +1,5 @@
+English | [简体中文](./README.zh-CN.md)
+
 <h1 align="center">Ant Design Pro Vue</h1>
 
 <div align="center">
@@ -13,13 +15,15 @@ An out-of-box UI solution for enterprise applications as a Vue boilerplate. base
 
 </div>
 
-[English](https://github.com/sendya/ant-design-pro-vue/blob/master/README.md) | [中文文档](https://github.com/sendya/ant-design-pro-vue/blob/master/README.zh-CN.md)
+- Preview: https://preview.pro.loacg.com
+- Home Page: https://pro.loacg.com
+- Documentation: https://pro.loacg.com/docs/getting-started
+- ChangeLog: https://pro.loacg.com/docs/changelog coming soon
+- FAQ: https://pro.loacg.com/docs/faq coming soon
 
 Overview
 ----
 
-[Preview](https://pro.loacg.com/)  **Example with some list**
-
 ![dashboard + multi-tabs](https://static-2.loacg.com/open/static/github/20190224163345.jpg)
 
 ![dashboard + setting](https://static-2.loacg.com/open/static/github/20181126112124.png)
@@ -41,7 +45,7 @@ Overview
 - [@antv/g2](https://antv.alipay.com/zh-cn/index.html) - AntV G2
 - [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation)  - Antv/G2 of Vue
 
-> Note:  [Yarn](https://yarnpkg.com/) package management is recommended,the exact same version loaded with the demo site of this project (yarn.lock) 。but you can also use npm
+> Note:  [Yarn](https://yarnpkg.com/) package management is recommended, the exact same version loaded with the demo site of this project (yarn.lock) . but you can also use npm
 
 
 ### Project setup
@@ -78,7 +82,7 @@ yarn run lint
 - **IMPORTANT : About Issue feedback !! Please describe your environment, the Pro version or branch used, what happened, etc. when opening Issue**
 
 - [Vue-cli3](https://cli.vuejs.org/guide/) used by the project.
-- Close Eslint (not recommended): remove `eslintConfig`  field in `package.json` 
+- Disable Eslint (not recommended): remove `eslintConfig`  field in `package.json` 
 
 - Easy-Mock used by project,[easy-mock](https://www.easy-mock.com/)  Project API Data [DO NOT CHANGE THE INTERFACE](https://www.easy-mock.com/project/5b7bce071f130e5b7fe8cd7d),If you want to modify, please fork [ANTD-PRO-Easy-Mock-API.zip](https://github.com/sendya/ant-design-pro-vue/files/2682711/ANTD-PRO-Easy-Mock-API.zip) and running to your server.