Skip to content

Commit

Permalink
Added Readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Tearle authored and Ian Tearle committed Mar 14, 2011
1 parent 3cfd346 commit 7179219
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
iSkip
=============

iSkip creates a container of images with a configurable key image. The effect is seen on Apple Mac computers when using iPhoto.

iSkip is created using the jQuery library.

Implementation
-------

### Calling iSkip

The simplest implementation to get iSkip working is by adding the code below. This will apply iSkip to a container with the ID of mousemove. Of course you can always add a class attribute if you wish to have multiple instances of iSkip on one page.

$("#mousemove").iskip();

### Options

You can specify extra options to ad greater control to your iSkip implementation.

There are two methods for iSkip to loop through the images.

mousemove

click

Addtionally by setting a number in cycle tells iSkip how fast to change the images in the container, the lower the number the faster iSkip skips the images.

cycle

See the statement below for how the iSkip demo was set up on this website.

$("#mousemove").iskip({images:array, method:'mousemove', 'cycle':3});

0 comments on commit 7179219

Please sign in to comment.