# jQuery.LocalScroll

### Installation and usage

Using [bower](https://github.com/twitter/bower):
```bash
bower install jquery.localScroll
```

### Notes

* Requires jQuery.ScrollTo (http://github.com/flesler/jquery.scrollTo)

* The hash of settings is passed in to jQuery.ScrollTo, so, in addition to jQuery.LocalScroll's settings, you can use any of jQuery.ScrollTo's. Check that plugin's documentation for further information.

* If you want to convert the links from ALL over the page, with the same settings, just call $.localScroll(...) instead of $(...).localScroll(...)

* Most of this plugin's defaults, belong to jQuery.ScrollTo, check it's demo for an example of each option.