Add license

Update Read Me

Author: liamtarpey

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Liam Tarpey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,4 +2,57 @@
 
 Single page component HTML5 video player component for Vue.js
 
-** Documentation coming soon...
+## Running this repository
+
+Clone this repository and run `yarn` or `npm install` to install all the dependencies.
+You can then run `npm run build` and this project will be running on `localhost:8080`
+
+## Using the component in your project
+
+Grab the `viewjs.vue` file in the `src` and copy it into your project.
+You will need some kind of module bundler to handle the `.vue` file - I'm using webpack for this example.
+
+1. Import the component into your project:
+`import ViewJs from './viewjs.vue';` (or whatever path you need)
+
+2. Define a data object that will be passed to the component on your parent component:
+```
+const videoWrapper = new Vue({
+    el: '#video-wrapper',
+    data: function() {
+        return {
+            viewJs: {
+                allowFullScreen: true,
+                preload: 'auto',
+                sources: [
+                    {
+                        url: 'http://nettuts.s3.amazonaws.com/763_sammyJSIntro/trailer_test.mp4',
+                        type: 'video/mp4'
+                    },
+                    {
+                        url: 'http://nettuts.s3.amazonaws.com/763_sammyJSIntro/trailer_test.ogg',
+                        type: 'video/ogg'
+                    }
+                ]
+            }
+        }
+    },
+    components: {
+        viewJs: ViewJs
+    }
+});
+```
+
+3. Include the component HTML in your page:
+```
+<div id="video-wrapper">
+    <view-js :props="viewJs"></view-js>
+</div>
+```
+
+## Options
+
+In your data object, you can define the following:
+- allowFullScreen | {Boolean} | if you want the full screen button to appear
+- preload         | {String}  | if you want the video to preload on page load. possible values are: `none`, `auto` & `metadata`
+- sources         | {Array}   | Array of objects containing `url` and `type` values