[incubator-apisix] branch doc-dashboard created (now 4ca8336)

[ju...@apache.org]

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

juzhiyuan pushed a change to branch doc-dashboard
in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git.


      at 4ca8336  Update README.md

This branch includes the following new commits:

     new 4ca8336  Update README.md

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[incubator-apisix] 01/01: Update README.md

[ju...@apache.org]

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

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

commit 4ca8336a17bed89ffa1f9bfc3a0da38a7d5a9ccd
Author: 琚致远 <ju...@apache.org>
AuthorDate: Tue Jan 21 16:06:42 2020 +0800

    Update README.md
---
 README.md | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 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.