Merge pull request Tencent#35 from Maizify/dev

update usage doc
Dandice · Jun 7, 2016 · 11f2cb7 · 11f2cb7
2 parents b63123d + 9dadcb2
commit 11f2cb7
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,14 @@ A lightweight, extendable front-end developer tool for mobile web page.
 
 ## Usage
 
+Download the [latest release](https://github.com/WechatFE/vConsole/releases/latest) or install via npm:
+
+```
+npm install vconsole
+```
+
+Import `dist/vconsole.min.js` to your project:
+
 ```html
 <script src="path/to/vconsole.min.js"></script>
 <script>

diff --git a/README_CN.md b/README_CN.md
@@ -17,6 +17,14 @@ vConsole
 
 ## 上手
 
+下载 vConsole 的[最新版本](https://github.com/WechatFE/vConsole/releases/latest)，或者使用 npm 安装：
+
+```
+npm install vconsole
+```
+
+引入 `dist/vconsole.min.js` 到项目中：
+
 ```html
 <script src="path/to/vconsole.min.js"></script>
 <script>

diff --git a/doc/tutorial.md b/doc/tutorial.md
@@ -7,14 +7,16 @@ Tutorial
 
 ### 1. Download
 
-Download file `dist/vconsole.min.js` to your project's directory.
+Download the [latest release](https://github.com/WechatFE/vConsole/releases/latest) of vConsole.
 
 Or, install via `npm` :
 
 ```
 npm install vconsole
 ```
 
+Then save `dist/vconsole.min.js` to your project.
+
 ### 2. Import
 
 (1) Under non-AMD/CMD rule, insert vConsole into `<head>`. To support further features, insert vConsole into `<head>` rather than `</body>` is a better choice.

diff --git a/doc/tutorial_CN.md b/doc/tutorial_CN.md
@@ -7,14 +7,16 @@
 
 ### 1.下载模块
 
-下载文件 `dist/vconsole.min.js` 到本地。
+下载 vConsole 的[最新版本](https://github.com/WechatFE/vConsole/releases/latest)。
 
 或者使用 `npm` 安装：
 
 ```
 npm install vconsole
 ```
 
+然后复制 `dist/vconsole.min.js` 到自己的项目中。
+
 ### 2.引入模块
 
 (1) 如果未使用 AMD/CMD 规范，可直接在 HTML 中引入 vConsole 模块。为了便于后续扩展，建议在 `<head>` 中引入：