vue-nav-tabs - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "vue-nav-tabs",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A vue based tab component",
@@ -5,0 +5,0 @@ "main": "dist/vue-tabs.js",

README.md

@@ -1,22 +0,49 @@
-# (WIP) Vue-tabs
+# Vue-tabs
+Simplified, customizable bootstrap based tabs
+Vue-tabs is a tab component which simplifies the usage of tabs and their customization
+## Demos
+* [Basic demo](https://jsfiddle.net/CristiJ/b44cc4dq/22/)
+* [Icons and colors](https://jsfiddle.net/CristiJ/b44cc4dq/26/)
+* [Full width centered tabs with text bellow](https://jsfiddle.net/CristiJ/b44cc4dq/29/)
+* [Vertical tabs](https://jsfiddle.net/CristiJ/b44cc4dq/32/)
 
-## Demo
-[Basic demo](https://jsfiddle.net/CristiJ/b44cc4dq/19/) WIP
 ## Usage
+## NPM
+`npm install vue-nav-tabs`
+
+## Or alternatively directly include the javascript
+Download the css and js files from `dist` folder or reference them directly from github (check jsfiddle links)
+```html
+<link rel="stylesheet" href="vue-tabs.min.css">
+<script src="vue-tabs.js"></script>
+```
+## Component registration
 ```js
+//global registration
+import 'vue-nav-tabs'
+import 'vue-nav-tabs/dist/vue-nav-tabs.min.css'
 Vue.use(VueTabs)
+
+//local registration
+import {VueTabs, VTab} from 'vue-nav-tabs'
+import 'vue-nav-tabs/dist/vue-nav-tabs.min.css'
+//component code
+components: {
+  VueTabs,
+  VTab
+}
 ```
 ```html
 <vue-tabs>
-    <tab-content title="First tab">
+    <v-tab title="First tab">
       First tab content
-    </tab-content>
+    </v-tab>
 
-    <tab-content title="Second tab">
+    <v-tab title="Second tab">
       Second tab content
-    </tab-content>
+    </v-tab>
 
-    <tab-content title="Third tab">
+    <v-tab title="Third tab">
       Third tab content
-    </tab-content>
+    </v-tab>
 </vue-tabs>
@@ -55,11 +82,15 @@ ```
 
-## Tab-content props
+## V-tab props
 
 ```js
 props: {
-  startIndex: {
-    type: Number,
-    default: 0
+  title: {
+    type: String,
+    default: ''
+  },
+  icon: {
+    type: String,
+    default: ''
   }
 }
 ```

No alert changes

Improved metrics

Number of lines in readme file

96

increased by47.69%

Worsened metrics

Total package byte prevSize

906221

decreased by-8.93%

No dependency changes