Skip to content

Commit

Permalink
fix(README): Closes codef0rmer#108
Browse files Browse the repository at this point in the history
  • Loading branch information
codef0rmerz committed Oct 1, 2014
1 parent c2d68f1 commit ad1c51d
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#Drag and Drop for AngularJS (with Animation)

---

###v1.0.5 - breaking change
Expand All @@ -13,6 +13,24 @@ Do not pass evaluated expressions in callbacks. For example,
<div jqyoui-draggable="{onStart:'startCallback(item)'}">{{item.title}}</div>
```

##How to Use

* bower install angular-dragdrop (or sudo bower install angular-dragdop --allow-root)
* Reference angular-dragdrop.min.js in your application as:
```
<script src="components/angular-dragdrop/src/angular-dragdrop.min.js"></script>
```
* Resolve the dependency in the main module of your application as:
```
angular.module('myApp', ['ngDragDrop'])
```

* Drag anything as:
```
<span data-drag="true" jqyoui-draggable>So you think you can drag</span>
```
* 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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ad1c51d

Please sign in to comment.