diff --git a/README.md b/README.md index c934a32..7f055bf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,90 @@ #Smoothslides -A simple, lightweight, and responsive jQuery slideshow by Kevin Thornbloom that features Ken Burns type animations. Now with tons of user customizable options! +A responsive jQuery slideshow with beautiful panning effects on each image. Created by Kevin Thornbloom +##Demo +Demo Page +##Usage +###Include CSS in header +``` + +``` +###Include JS in footer (after loading jQuery) +``` + + +``` +###Add HTML Markup for slides +``` +
+``` +Note- to add a caption, put a title on that slide's div. -##Demo and Usage Info -http://kthornbloom.com/smoothslides.php +##Options +Option | +Description | +Values | +
playTimer | +Time (in milliseconds) each slide is visible for | +3000 | +
order | +How to order the slides | +'normal' , 'reverse' or 'random' | +
animEasing | +CSS3 easing type for animations | +'ease-in-out' | +
nextText | +Text for the next button | +'›' | +
prevText | +Text for the previous button | +'‹' | +
captions | +Show captions? | +'true' or 'false' | +
navigation | +Show Next/Prev buttons? | +'true' or 'false' | +
pagination | +Show dots representing slides? | +'true' or 'false' | +
autoanimType | +Animation to be used while automatically playing | +'random', 'zoomIn', 'zoomOut', 'panLeft', 'panRight', 'panUp', 'panDown', 'crossFade','none' | +