Skip to content

Commit eb53fc6

Browse files
author
Karl Swedberg
committed
added a note to the readme
1 parent 4ff8dcd commit eb53fc6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

readme.textile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
h1. Smooth Scroll Plugin
22

3+
h2. Features
4+
35
* Allows for easy implementation of smooth scrolling for same-page links.
46
* Works like this: $('a').smoothScroll();
57
* Specify a containing element if you want: $('#container a').smoothScroll();
68
* Exclude links if they are within a containing element: $('#container a').smoothScroll({excludeWithin: ['.container2']});
79
* Exclude links if they match certain conditions: $('a').smoothScroll({exclude: ['.rough','#chunky']});
810
* Adjust where the scrolling stops: $('.backtotop').smoothScroll({offset: -100});
11+
12+
h2. Flaws
13+
14+
* No history/back-button management

0 commit comments

Comments
 (0)