Permalink
Browse files

added a note to the readme

  • Loading branch information...
1 parent 4ff8dcd commit eb53fc63971595c7bb468a64ba964e02d6367e1a Karl Swedberg committed Sep 21, 2009
Showing with 6 additions and 0 deletions.
  1. +6 −0 readme.textile
View
@@ -1,8 +1,14 @@
h1. Smooth Scroll Plugin
+h2. Features
+
* Allows for easy implementation of smooth scrolling for same-page links.
* Works like this: $('a').smoothScroll();
* Specify a containing element if you want: $('#container a').smoothScroll();
* Exclude links if they are within a containing element: $('#container a').smoothScroll({excludeWithin: ['.container2']});
* Exclude links if they match certain conditions: $('a').smoothScroll({exclude: ['.rough','#chunky']});
* Adjust where the scrolling stops: $('.backtotop').smoothScroll({offset: -100});
+
+h2. Flaws
+
+* No history/back-button management

0 comments on commit eb53fc6

Please sign in to comment.