Update README.md

savoygu · savoygu · commit f022eaa1b49b · 2017-07-21T17:29:07.000+08:00
diff --git a/README.md b/README.md
@@ -1,6 +1,53 @@
 # vue-demonstration
 
-> Vue-based element docs's demo code style component, asily add examples to your vue project to show your code. 
+> Vue-based element docs's demo code style component, easily add examples to your Vue project to show your code.
+
+## Install 
+
+```bash
+npm install vue-demonstration -S
+```
+
+## Quick Start
+ 
+```bash
+ import Vue from 'vue'
+ import VueDemo from 'vue-demonstration'
+ 
+ Vue.component('vue-demonstration', VueDemo)
+ ```
+ 
+For more information, please refer to [vue-demonstration](http://savoygu.github.io/vue-demonstration) in our documentation.
+ 
+## Usage
+ 
+```
+<template>
+  <vue-demonstration
+    title="标题"
+    description="标题描述"
+    anchor="锚点"
+    tag="标题标签" <!-- h2 / h3-->
+    :highlight="sourcecode">
+    <template slot="source">
+      <div>your code</div> <!-- 源代码-->
+    </template>
+    <template slot="explanation">
+      代码描述
+    </template>
+  </vue-demonstration>
+</template>
+<script>
+  const sourcecode = `<div>your code</div>`
+  export default {
+     data () {
+        sourcecode
+     }
+  }
+</script>
+```
+
+If you want to add some javascript code to `sourcecode`，you need to put the `sourcecode` into a js file.
 
 ## Build Setup
 
@@ -19,4 +66,10 @@ npm run demo:prepublish
 
 # build for production with minification
 npm run build
+
+# generate gh-pages
+npm run deploy
 ```
+## LICENSE
+
+[MIT](http://opensource.org/licenses/MIT)
