From 35a89191bac5d9cbcbba9ad9683732dc4eb5ac58 Mon Sep 17 00:00:00 2001 From: Kevin Thornbloom Date: Sat, 4 Jan 2014 22:22:22 -0500 Subject: [PATCH] Update README.md --- README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 85 insertions(+), 3 deletions(-) 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescriptionValues
playTimerTime (in milliseconds) each slide is visible for3000
orderHow to order the slides'normal' , 'reverse' or 'random'
animEasingCSS3 easing type for animations'ease-in-out'
nextTextText for the next button'›'
prevTextText for the previous button'‹'
captionsShow captions?'true' or 'false'
navigationShow Next/Prev buttons?'true' or 'false'
paginationShow dots representing slides?'true' or 'false'
autoanimTypeAnimation to be used while automatically playing'random', 'zoomIn', 'zoomOut', 'panLeft', 'panRight', 'panUp', 'panDown', 'crossFade','none'
##Licensing Free to use and modify personally or commercially. Not for resale.