working on readme

dowjones · Mar 3, 2015 · d15cc7d · d15cc7d
1 parent 077b582
commit d15cc7d
Showing 1 changed file with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,12 +2,44 @@
 
 Basic Slideshow Component
 
-## Usage
+## Basic Options
+
+```javascript
+
+  <PictureShow
+    slides={[
+      {width: 100, height: 100, src: ''},
+      {width: 100, height: 100, src: ''}
+    ]}
+    ratio={[3,2]}
+    onTransition={function(){}}
+    startingSlide=1
+    />
+
+```
 
 ### Basic
 
 ```javascript
-  console.log('hello world');
+  var PictureShow = require('react-picture-show');
+
+  var slides = [{
+    width: 900,
+    height: 600,
+    src: 'http://placehold.it/900x600'
+  }, {
+    width: 600,
+    height: 900,
+    src: 'http://placehold.it/600x900'
+  }, {
+    width: 600,
+    height: 600,
+    src: 'http://placehold.it/600x600'
+  }];
+
+  // in jsx
+
+  <PictureShow ratio={[3,2]} slides={slides}/>
 ```
 
 ### Configuration