Skip to content

Commit

Permalink
Add readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrfalba committed Nov 29, 2012
1 parent c657e88 commit 9d6d0f6
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Jquery Floater 0.5a

## How to get (and contribute) Floater

1. Start a new project in git.
2. Fork http://github.com/piotrfalba/jquery-floater
3. Add jquery-floater as submodules of your project...
git submodule add [email protected]:_YOU_/jquery-floater.git jquery-floater
4. Learn a little more about submodules ...
http://johnleach.co.uk/words/archives/2008/10/12/323/git-submodules-in-n-easy-steps
5. Make changes in Floater, and push them back to your fork.
6. Make a pull request to your fork.


## Getting Started with Floater

$("#container").floater({
duration : 400, - duration of animation
minimumMargin: 20, - minimum margin between floating boxes
maximumMargin: 40, - maximum margin between floating boxes
easing : 'linear', - easing
boxClass : '.box', - floating box selector
fluidHeight : false, - give true for fluid container height
callback : function() {
... - your callback function
}
});

0 comments on commit 9d6d0f6

Please sign in to comment.