Merge branch 'master' of https://github.com/David-Desmaisons/Vue.Dragable.For

Author: pc-david\david.desmaisons

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Desmaisons
+
+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,6 +2,60 @@
 Vue directive for lists allowing drag-and-drop sorting in sync with View-Model. Based on [Sortable.js](https://github.com/RubaXa/Sortable)
 
 
-#Example
+##Motivation
+
+Create a directive that displays a dragable list and keeps in sync the view and underlying view model.
+
+##Demo
+
+Simple:
 
 https://jsfiddle.net/dede89/j62g58z7/
+
+Two Lists:
+
+https://jsfiddle.net/dede89/hqxranrd/
+
+##Feature
+
+* Full support of [Sortable.js](https://github.com/RubaXa/Sortable) options via options parameters
+* Keeps in sync view model and view
+* No jquery dependency
+
+##Usage
+
+Use it exactly as v-for directive, passing optional parameters using 'options' parameter.
+
+  ``` html
+ <template v-dragable-for="element in list1" options='{"group":"people"}'>
+    <p>{{element.name}}</p>
+  </template>
+   ```
+## Installation
+- Available through:
+``` js
+ npm install vuedragablefor
+```
+``` js
+ Bower install vue.dragable.for
+```
+- #### For Modules
+
+  ``` js
+  // ES6
+  import Vue from 'vue'
+  import VueDragableFor from 'vuedragablefor'
+  Vue.use(VueDragableFor)
+
+  // ES5
+  var Vue = require('vue')
+  Vue.use(require('vuedragablefor'))
+  ```
+
+- #### For `<script>` Include
+
+  Just include `vue.dragable.for.js` after Vue itself.
+  
+## License
+  
+  [MIT](https://github.com/David-Desmaisons/Vue.Dragable.For/blob/master/LICENSE)