add config vars for #310 to readme
authorHakim El Hattab <hakim.elhattab@gmail.com>
Thu, 31 Jan 2013 05:06:06 +0000 (00:06 -0500)
committerHakim El Hattab <hakim.elhattab@gmail.com>
Thu, 31 Jan 2013 05:06:06 +0000 (00:06 -0500)
README.md

index d24f4388c5687464ca97a0993635c1e19fe1c40c..ea6be5e7f17aa6b5553c3b1ddf0344461565ec54 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,6 +55,20 @@ At the end of your page you need to initialize reveal by running the following c
 
 ```javascript
 Reveal.initialize({
+
+       // The "normal" size of the presentation, aspect ratio will be preserved
+       // when the presentation is scaled to fit different resolutions. Can be
+       // specified using percentage units.
+       width: 960,
+       height: 700,
+
+       // Factor of the display size that should remain empty around the content
+       margin: 0.1,
+
+       // Bounds for smallest/largest possible scale to apply to content
+       minScale: 0.2,
+       maxScale: 1.4,
+
        // Display controls in the bottom right corner
        controls: true,
 
@@ -92,6 +106,7 @@ Reveal.initialize({
 
        // Transition style
        transition: 'default' // default/cube/page/concave/zoom/linear/fade/none
+
 });
 ```