From d489ec2f9ddddb9e502c3cccbfe277f84c22963b Mon Sep 17 00:00:00 2001
From: hakimel
Date: Mon, 21 Jan 2013 12:45:52 -0500
Subject: add overviewshown and overviewhidden events (closes #298)

---
 README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index d7bf4c8..b5f374f 100644
--- a/README.md
+++ b/README.md
@@ -256,7 +256,15 @@ Reveal.addEventListener( 'fragmenthidden', function( event ) {
 ### Overview mode
 
 Press "Esc" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides,
-as if you were at 1,000 feet above your presentation.
+as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:
+
+```javascript
+Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } );
+Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );
+
+// Toggle the overview mode programmatically
+Reveal.toggleOverview();
+```
 
 ### Fullscreen mode
 Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
-- 
cgit v1.2.3