Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A few simple changes to the README.md file #9

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

A few simple changes to the README.md file #9

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c05c887
Update README.md
deanhume Feb 10, 2014
43eebc9
Updated Wikipedia Link & also div tag Id in Readme
deanhume Feb 10, 2014
32279e9
Updated jQuery ref to point to correct div
deanhume Feb 12, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Kenburns
========
Kenburns.js is a lightweight and flexible Jquery gallery plugin that loads a list of images and transitions them using a pan-and-zoom, _[Ken Burns](http://en.wikipedia.org/wiki/Ken_Burns_effect)_ style effect.
Kenburns.js is a lightweight and flexible Jquery gallery plugin that loads a list of images and transitions them using a pan-and-zoom, [Ken Burns](http://en.wikipedia.org/wiki/Ken_Burns_effect) style effect.

Example: <http://www.toymakerlabs.com/kenburns>

Expand All @@ -25,7 +25,7 @@ Usage
-------------------
Basic plugin use looks like this:

$("#wrapper").Kenburns({
$("#kenburns_slideshow").Kenburns({
images:["image0.jpg", "image2.jpg"],
scale:1,
duration:6000,
Expand Down Expand Up @@ -70,7 +70,7 @@ Include the the CSS. The plugin wraps images in divs with a class of _.kb-slide_
######3. SCRIPT
Then initialize the plugin. In the example below, it should log the current slide and a message when loading has completed.

$("#wrapper").Kenburns({
$("#kenburns_slideshow").Kenburns({
images:[
"images/image0.jpg",
"images/image1.jpg",
Expand All @@ -91,8 +91,6 @@ Then initialize the plugin. In the example below, it should log the current slid
});




How it Works
-------------------
######Loading
Expand Down Expand Up @@ -155,7 +153,7 @@ A callback function when the images have finished loading.

Dependencies
-----
Jquery 1.8.2.
Jquery 1.8.2 +.

It will probably work fine in previous versions but it hasn't yet been tested.

Expand Down