Skip to content

Commit

Permalink
Added Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
jellekralt committed Aug 3, 2015
1 parent 3056f2a commit ee211b5
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
# angular-drag-scroll
# Angular Drag to Scroll
Lightweight drag to scroll directive for AngularJS

## Installation
* Bower: ```bower install angular-drag-scroll --save```
* Download: you can just download the files from [Github](https://github.com/jellekralt/angular-drag-scroll/archive/master.zip)

## Usage
* Include ```ng-drag-scroll.js``` in your HTML template:

```html
<script src="angular.js"></script>
<script src="ng-drag-scroll.js"></script>
```

* Add a dependency to the ng-drag-scroll module in your application.

```javascript
angular.module('MyApp', ['ng-drag-scroll']);
```

* Add an attribute to an element with a scrollbar to make the content scrollable

```html
<div drag-scroll>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec a diam lectus. Sed sit amet ipsum mauris. Maecenas congue ligula ac quam viverra nec consectetur ante hendrerit. Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean ut gravida lorem. Ut turpis felis, pulvinar a semper sed, adipiscing id dolor. Pellentesque auctor nisi id magna consequat sagittis. Curabitur dapibus enim sit amet elit pharetra tincidunt feugiat nisl imperdiet. Ut convallis libero in urna ultrices accumsan. Donec sed odio eros. Donec viverra mi quis quam pulvinar at malesuada arcu rhoncus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. In rutrum accumsan ultricies. Mauris vitae nisi at sem facilisis semper ac in est.</p>
</div>
```

## Credits / Inspiration
* https://github.com/asvd/dragscroll

## License
MIT: http://jellekralt.mit-license.org/
2 changes: 1 addition & 1 deletion src/ng-drag-scroll.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
'use strict';

angular
.module('dragscroll')
.module('ng-drag-scroll')
.directive('dragScroll', DragScroll);

DragScroll.$inject = ['$document', '$window', '$parse'];
Expand Down

0 comments on commit ee211b5

Please sign in to comment.