forked from chu888chu888/jquery-floater
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c657e88
commit 9d6d0f6
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
} | ||
}); |