populate README

README.md

@@ -1,7 +1,53 @@
-# vue-bootstrap-calendar
+# Vue Bootstrap Calendar
 
-> Use the magical power of VueJS and beauty of Twitter Bootstraps to create a powerful Calendar App
+> Uses the magical power of VueJS v2 and beauty of Twitter Bootstraps to create a powerful Responsive Calendar App. See the [Demo site](https://eazyserver.github.io/Vue-Bootstrap-Calendar/).
 
-## Build Setup
+The calender only uses bootstrap ``CSS``, NO ``bootstrap.js`` or ``jquery.js`` is needed for this project. Its purely Vue2 implementation.
 
- [Demo site](https://eazyserver.github.io/Vue-Bootstrap-Calendar/).
+Vue-Bootsrtap-Calendar is locale/language ready, but only English and Arabic is implemented for now. Maybe you can help?
+
+## How to get vue-bootstrap-calendar #
+
+You can install via npm
+
+       $ npm install -S vue-bootstrap-calendar
+
+OR you can include the compiled file found in "dist/vbc.js" directly into your project like so:
+
+```html
+<div class="container">
+
+    <div class="page-header">
+        <h1>Vue Bootstrap Calendar</h1>
+        <p class="lead"></p>
+    </div>
+
+    <div id="app">
+        <Calendar :first-day="0"></Calendar>
+    </div>
+</div>
+<script src="dist/vbc.js"></script>
+<script>
+    var app = new Vue( {
+        el        : '#app',
+        i18n,
+        mounted() {
+            let loadingIndicator = document.getElementById( "loading" );
+            if(loadingIndicator != null){
+                loadingIndicator.style.display = "none";
+            }
+        }
+    } );
+</script>
+```
+
+## How to use vue-bootstrap-calendar #
+Simply include ```<Calendar :first-day="x"></Calendar>``` in your vue app. ``x`` is an integer for the start of the week, which can be one of the following values ``0,1,2,3,4,5,6``, where 0 for Sunday, 1 for Monday and so on...
+
+
+## Copyright and License
+
+[Vue-Bootstrap-Calendar](https://github.com/EazyServer/Vue-Bootstrap-Calendar) was written by [Yarob Al-Taay](https://twitter.com/TheEpicVoyage) and is released under the 
+[MIT License](LICENSE.md).
+
+Copyright (c) 2017 Yarob Al-Taay

index.html

@@ -12,7 +12,12 @@
 <div class="container">
 
 	<div class="page-header">
-		<h1>Vue Bootstrap Calendar</h1>
+		<div class="row">
+			<div class="col-sm-6"><h3>Vue Bootstrap Calendar</h3></div>
+			<div class="col-sm-6">
+				<h3><a class="pull-right" href="https://github.com/EazyServer/Vue-Bootstrap-Calendar">Fork me on Github</a></h3>
+			</div>
+		</div>
 		<p class="lead"></p>
 	</div>
 

package.json

@@ -1,9 +1,12 @@
 {
   "name": "vue-bootstrap-calendar",
-  "description": "Use the magical power of VueJS and beauty of Twitter Bootstraps to create a powerful Calendar App",
+  "description": "Uses the magical power of VueJS v2 and beauty of Twitter Bootstraps to create a powerful Responsive Calendar App.",
   "version": "1.0.0",
-  "author": "yarob <[email protected]>",
-  "private": true,
+  "author": "yarob <[email protected]>",
+  "homepage": "https://github.com/EazyServer/Vue-Bootstrap-Calendar",
+  "bugs": {
+    "url" : "https://github.com/EazyServer/Vue-Bootstrap-Calendar/issues"
+  },
   "scripts": {
     "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
     "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
@@ -25,5 +28,6 @@
     "vue-template-compiler": "^2.2.1",
     "webpack": "^2.2.0",
     "webpack-dev-server": "^2.2.0"
-  }
+  },
+  "license" : "MIT"
 }