From dd81ae3bc4a4e9321d0b329fa0e5fe3268c29169 Mon Sep 17 00:00:00 2001 From: Luis Date: Sat, 11 Feb 2017 16:58:15 +0100 Subject: [PATCH] README.md update --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bccbd8..e35654e 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,28 @@ Version 0.1 (Jan 8, 2017):
<article id="webslides" class="vertical">
+### How it works + +You need to add the follow javascript to initialize the webslide objet + +```javascript +var slide = jQuery('#webslides').webslides(); +``` + +Now you can use the slide with these functions + +```javascript +// Moving to next slide +slide.nextSlide(); +// Moving to previous slide +slide.previousSlide(); +// Moving to a specific slide +slide.goToSlide(n); +``` + ### What's in the download? -The download includes demos and images (devices and logos). +The download includes demos and images (devices and logos). All content is for demo purposes only. Images are property of their respective owners. ``` @@ -77,7 +96,7 @@ You can add: ### License -WebSlides is licensed under the [MIT License](https://opensource.org/licenses/MIT). +WebSlides is licensed under the [MIT License](https://opensource.org/licenses/MIT). Use it to make something cool. ### Credits