Improve documentation

Author: val-bubbleflat

README.md

@@ -1,12 +1,37 @@
 # Laravel Component Loading
 
-by bubbleflat.com
+by [bubbleflat.com]()
 
-TODO Description
+This package allows you to manage a loading state inside all component, and to display a progressbar (thanks to [vue-progressbar](https://github.com/hilongjw/vue-progressbar)) to show the global loading state of your app.
+
+All components have their own loading state, but the progressbar show the global loading state of all components.
 
 ## Installation
 
-TODO
+````
+npm install vue-component-loading
+````
+
+```javascript
+import VueLoading from 'vue-component-loading'
+
+let config = {
+  progressBar:{
+    color: '#000',
+    failedColor: '#874b4b',
+    thickness: '5px',
+    transition: {
+      speed: '0.2s',
+      opacity: '0.6s',
+      termination: 300
+    },
+  }
+}
+
+Vue.use(VueLoading, config);
+```
+
+See [progressbar doc](https://github.com/hilongjw/vue-progressbar#constructor-options) for all options for the progressbar
 
 ## Usage
 
@@ -19,22 +44,22 @@ First, register your progressbar :
 </template>
 ```
 
-In a component you can use to manage the loading state of your component
+You can use these methods inside a component to manage its loading state
 
 ```javascript
-this.startLoading();
-this.endLoading();
-this.failLoading();
+this.startLoading(); // --> this.loading = true : the component starts to load, the progressbar appear
+this.endLoading(); // --> this.loading = false : the component end to load, the progressbar progress :p (if it's the last component, it disappear)
+this.failLoading(); // --> this.loading = false : show the fail progressbar
 ```
 
-According to this state, you can access `loading` data in your component
+Depending on the loading state, you can access `loading` boolean in your component
 
 ## Exemple
 
 ```html
 <template>
     <div v-if="!loading">
-        Component Loading !
+        Component Loaded !
     </div>
 </template>
 <script>
@@ -51,4 +76,8 @@ According to this state, you can access `loading` data in your component
     }
 
 </script>
-```
+```
+
+## License
+
+[The MIT License](https://opensource.org/licenses/MIT)

package.json

@@ -1,13 +1,32 @@
 {
   "name": "vue-component-loading",
   "version": "1.0.0",
-  "description": "Vuejs package to use a loading boolean inside a component",
+  "description": "Vuejs package, allow you to manage a loading state inside all component, and to display a progressbar",
   "main": "src/index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "author": "val-bubbleflat",
-  "license": "ISC",
+  "author": {
+    "name": "Valentin Vivies - Bubbleflat",
+    "email": "[email protected]",
+    "url": "https://bubbleflat.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/val-bubbleflat/vue-component-loading"
+  },
+  "keywords": [
+    "vue",
+    "vue-component-loading",
+    "vue loading",
+    "progressbar",
+    "vue progressbar"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/val-bubbleflat/vue-component-loading/issues"
+  },
+  "homepage": "https://github.com/val-bubbleflat/vue-component-loading#readme",
   "dependencies": {
     "vue-progressbar": "^0.7.3"
   }