update readme

README.md

@@ -1,24 +1,55 @@
-# keybord
+## Installation
+```
+npm install git+https://git.wm-app.xyz/dev/vue-keyborad.git
+```
+or
+```
+yarn add git+https://git.wm-app.xyz/dev/vue-keyborad.git
+```
+## Initialization
+```javascript
+import Vue from 'vue'
+import Keyborad from 'keyborad'
+Vue.use(Keyborad);
+```
+## Usage
+```vue
+<template>
+    <div id="app">
+        <h1>{{val}}</h1>
+        <keyborad v-model="val" />
+    </div>
+</template>
 
-## Project setup
+<script>
-```
+export default {
-yarn install
+    data() {
+        return {
+            val: ''
+        }
+    },
+}
+</script>
 ```
+## Page Usage
+```vue
+<template>
+    <div id="app">
+        <h1>{{val}}</h1>
+        <keyborad v-model="val" />
+    </div>
+</template>
 
-### Compiles and hot-reloads for development
+<script>
-```
+import Keyborad from 'keyborad'
-yarn serve
-```
 
-### Compiles and minifies for production
+export default {
+    components: {Keyborad},
+    data() {
+        return {
+            val: ''
+        }
+    },
+}
+</script>
 ```
-yarn build
-```
-
-### Lints and fixes files
-```
-yarn lint
-```
-
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).