add auto-slide instructions to readme
authorHakim El Hattab <hakim.elhattab@gmail.com>
Sun, 13 Oct 2013 19:51:13 +0000 (15:51 -0400)
committerHakim El Hattab <hakim.elhattab@gmail.com>
Sun, 13 Oct 2013 19:51:13 +0000 (15:51 -0400)
README.md

index 01579ba9c388c8faadf33e114f140c04133998e6..8e2cc1e7c0cba24ad18ab29d1caf8429e4d48746 100644 (file)
--- a/README.md
+++ b/README.md
@@ -205,6 +205,27 @@ Reveal.initialize({
 });
 ```
 
+
+### Auto-sliding
+
+Presentations can be configure to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:
+
+```javascript
+// Slide every five seconds
+Reveal.configure({
+  autoSlide: 5000
+});
+```
+
+When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Sliding is also paused automatically as soon as the user starts navigating. You can disable these controls by specifying ```autoSlideStoppable: false``` in your reveal.js config.
+
+You can also override the slide duration for individual slides by using the ```data-autoslide``` attribute on individual sections:
+
+```html
+<section data-autoslide="10000">This will remain on screen for 10 seconds</section>
+```
+
+
 ### Keyboard Bindings
 
 If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option: