From fbbffb6f23c6f10d274d4a8ca8e8c41df011ce52 Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Sun, 13 Oct 2013 15:51:13 -0400 Subject: [PATCH] add auto-slide instructions to readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 01579ba9..8e2cc1e7 100644 --- 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 +
This will remain on screen for 10 seconds
+``` + + ### Keyboard Bindings If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option: