readme update
authorHakim El Hattab <hakim.elhattab@gmail.com>
Tue, 18 Jun 2013 13:09:19 +0000 (10:09 -0300)
committerHakim El Hattab <hakim.elhattab@gmail.com>
Tue, 18 Jun 2013 13:09:19 +0000 (10:09 -0300)
README.md

index e4eef922cfd03e39fd77725ffd564a2991c3facd..2c0ae5f3bc40bef3d932bfb31d3647df7bdc9f8d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -206,12 +206,19 @@ Reveal.next();
 Reveal.prevFragment();
 Reveal.nextFragment();
 Reveal.toggleOverview();
+Reveal.togglePause();
 
 // Retrieves the previous and current slide elements
 Reveal.getPreviousSlide();
 Reveal.getCurrentSlide();
 
 Reveal.getIndices(); // { h: 0, v: 0 } }
+
+// State checks
+Reveal.isFirstSlide();
+Reveal.isLastSlide();
+Reveal.isOverview();
+Reveal.isPaused();
 ```
 
 ### Ready event
@@ -236,21 +243,9 @@ Reveal.addEventListener( 'slidechanged', function( event ) {
 } );
 ```
 
-### States
-
-If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
-
-Furthermore you can also listen to these changes in state via JavaScript:
-
-```javascript
-Reveal.addEventListener( 'somestate', function() {
-       // TODO: Sprinkle magic
-}, false );
-```
-
 ### Slide backgrounds
 
-Slides are contained withing a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page background colors or images by applying a ```data-background``` attribute to your ```<section>``` elements. Below are a few examples.
+Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page background colors or images by applying a ```data-background``` attribute to your ```<section>``` elements. Below are a few examples.
 
 ```html
 <section data-background="#ff0000">
@@ -267,6 +262,19 @@ Slides are contained withing a limited portion of the screen by default to allow
 Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing ```backgroundTransition: 'slide'``` to the ```Reveal.initialize()``` call. Alternatively you can set ```data-background-transition``` on any section with a background to override that specific transition.
 
 
+### States
+
+If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
+
+Furthermore you can also listen to these changes in state via JavaScript:
+
+```javascript
+Reveal.addEventListener( 'somestate', function() {
+       // TODO: Sprinkle magic
+}, false );
+```
+
+
 ### Internal links
 
 It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):