You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by we...@apache.org on 2020/01/21 09:58:33 UTC

[incubator-apisix] branch master updated: doc: Update README.md (#1087)

This is an automated email from the ASF dual-hosted git repository.

wenming pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 1c58e19  doc: Update README.md (#1087)
1c58e19 is described below

commit 1c58e19cbdda43cb40f74bf13e23d962830888e6
Author: 琚致远 <ju...@apache.org>
AuthorDate: Tue Jan 21 17:58:24 2020 +0800

    doc: Update README.md (#1087)
---
 README.md    | 17 ++++++++++-------
 README_CN.md | 15 +++++++++------
 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index d21b30f..6b7112b 100644
--- a/README.md
+++ b/README.md
@@ -138,20 +138,23 @@ you can follow the [documentation of limit count](doc/plugins/limit-count.md).
 Then you can try more [plugins](doc/README.md#plugins).
 
 ## Dashboard
-APISIX has built-in support for dashboards, as follows:
+APISIX has built-in support for Dashboard, as follows:
 
-- Download the source code of [dashboard](https://github.com/apache/incubator-apisix-dashboard):
+1. Please make sure your machine has Node 8.x or higher, or there will occur build issues.
+
+2. Download the source codes of [Dashboard](https://github.com/apache/incubator-apisix-dashboard):
 ```
 git clone https://github.com/apache/incubator-apisix-dashboard.git
 ```
-- install yarn: refer to [documentation](https://yarnpkg.com/en/docs/install)
-- Install dependencies and build
+
+3. Install [yarn](https://yarnpkg.com/en/docs/install)
+
+4. Install dependencies then run build command:
 ```
-yarn
-yarn run build:prod
+yarn && yarn build:prod
 ```
 
-- Integration with APISIX
+5. Integration with APISIX
 Copy the compiled files under `/dist` directory to the `apisix/dashboard` directory,
 open `http://127.0.0.1:9080/apisix/dashboard/` in the browser.
 Do not need to fill the user name and password, log in directly.
diff --git a/README_CN.md b/README_CN.md
index 7346f3b..19e3aca 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -140,18 +140,21 @@ sudo apisix start
 
 APISIX 内置了对 Dashboard 的支持,使用步骤如下:
 
-- 下载 [Dashboard](https://github.com/apache/incubator-apisix-dashboard) 的源码:
+1. 确保你的运行环境中的 Node 版本高于或等于 8.x。
+
+2. 下载 [Dashboard](https://github.com/apache/incubator-apisix-dashboard) 的源码:
 ```
 git clone https://github.com/apache/incubator-apisix-dashboard.git
 ```
-- 安装yarn: 参考[安装文档](https://yarnpkg.com/zh-Hans/docs/install)
-- 安装依赖并构建
+
+3. 安装 [yarn](https://yarnpkg.com/zh-Hans/docs/install)
+
+4. 安装依赖并构建
 ```
-yarn
-yarn run build:prod
+yarn && yarn build:prod
 ```
 
-- 与 APISIX 集成
+5. 与 APISIX 集成
 把编译后的在 `/dist` 目录下的所有文件,拷贝到 `apisix/dashboard` 目录下。
 使用浏览器打开 `http://127.0.0.1:9080/apisix/dashboard/` 即可使用,
 不用填写用户名和密码,直接登录。