diff --git a/README.md b/README.md index ade20d0..f242ce3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ #Drag and Drop for AngularJS (with Animation) - + --- ###v1.0.5 - breaking change @@ -13,6 +13,24 @@ Do not pass evaluated expressions in callbacks. For example,
{{item.title}}
``` +##How to Use + + * bower install angular-dragdrop (or sudo bower install angular-dragdop --allow-root) + * Reference angular-dragdrop.min.js in your application as: + ``` + +``` + * Resolve the dependency in the main module of your application as: +``` +angular.module('myApp', ['ngDragDrop']) +``` + + * Drag anything as: + ``` + So you think you can drag + ``` + * Finally, check out [the cool demos](http://codef0rmer.github.io/angular-dragdrop/#/) + ##Angular Draggable options * **jqyoui-draggable** – A custom angular attribute to make any element draggable. It holds more settings such as: * **index** – number – $index of an item of a model (if it is an array) associated with it @@ -41,7 +59,8 @@ Do not pass evaluated expressions in callbacks. For example, * **data-jqyoui-options** – object – should hold all the valid options supported by [jQueryUI Droppable](http://api.jqueryui.com/droppable) * **ng-model** – string – An angular model defined in a controller. Should be a JS array or object. -##Set up +##How to Contribute +* $ git clone https://github.com/codef0rmer/angular-dragdrop.git * $ cd angular-dragdrop * $ sudo npm install * $ sudo bower install