vue-offcanvas-simple - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "vue-offcanvas-simple",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "a simple off canvas sidebar for use in vuejs 2.0 projects",
@@ -5,0 +5,0 @@ "main": "src/SidebarOffCanvas.vue",

README.md

 # vue-offcanvas-simple
 A basic vuejs off canvas sidebar component
+
+## Installation
+
+```
+$ npm install vue-offcanvas-simple --save
+```
+
+
+## Examples
+
+```vue
+<template>
+  <div>
+    <off-canvas v-model="show" :width="300" :duration=".5" effect="ease-in-out" @sidebarWasClosed="show = $event">
+        Sidebar Content goes here
+    </off-canvas>
+    <div>
+          <button @click="show = !show">Toggle</button><button @click="show = false">Close</button>
+          <p>{{ show }}</p>
+    </div>
+  </div>
+</template>
+
+<script>
+import offCanvas from 'vue-offcanvas-simple/src/SidebarOffCanvas.vue'
+
+export default {
+  data() {
+    return {
+      show: false
+    }
+  },
+  components: {
+    offCanvas
+  }
+}
+</script>
+
+```
+
+## Badges
+
+![](https://img.shields.io/badge/license-MIT-blue.svg)
+![](https://img.shields.io/badge/status-stable-green.svg)
+
+---
+
+
+> GitHub [@norbert989](https://github.com/norbert989n)
+

No alert changes

Improved metrics

Total package byte prevSize

4876

increased by20.69%

Number of lines in readme file

53

increased by1666.67%

No dependency changes