Add API documentation

Author: Nhacsam

README.md

@@ -43,6 +43,26 @@ render() {
 All of the properties of `ScrollView` are supported. Please refer to the
 [`ScrollView` documentation](https://facebook.github.io/react-native/docs/scrollview.html) for more detail.
 
+The `HeaderImageScrollView` handle also the following props. None is required :
+
+### Header
+| Property | Type | Default | Description |
+| -------- | ---- | ------- | ----------- |
+| `renderHeader` | `function` | Empty view | Function which return the component to use as header. It can return background image for example. |
+| `maxHeight` | `number` | `80` | Max height for the header |
+| `minHeight` | `number` | `125` | Min height for the header (in navbar mode) |
+| `minOverlayOpacity` | `number` | `0` | Opacity of a black overlay on the header before any scroll |
+| `maxOverlayOpacity` | `number` | `0.3` | Opacity of a black overlay on the header when in navbar mode |
+
+
+### Foreground
+
+| Property | Type | Default | Description |
+| -------- | ---- | ------- | ----------- |
+| `renderForeground` | `function` | Empty view | Function which return the component to use at foreground. The component is render in front of the header and scroll with the ScrollView. It can return a title for example.|
+| `foregroundParallaxRatio` | `number` | `1` | Ration for parallax effect of foreground when scrolling. If 2, the header goes up two times faster than the scroll |
+| `fadeOutForeground` | `bool` | `false` | If set, add a fade out effect on the foreground when scroll up |
+
 ## Other open-source modules by the folks at [BAM](http://github.com/bamlab)
 
  * [generator-rn-toolbox](https://github.com/bamlab/generator-rn-toolbox)

exemple/.babelrc renamed to example/.babelrc

@@ -144,28 +144,28 @@ class ImageHeaderScrollView extends Component {
 }
 
 ImageHeaderScrollView.propTypes = {
-  renderHeader: React.PropTypes.func,
-  renderForeground: React.PropTypes.func,
-  maxHeight: React.PropTypes.number,
-  minHeight: React.PropTypes.number,
   children: React.PropTypes.node || React.PropTypes.nodes,
-  maxOverlayOpacity: React.PropTypes.number,
-  minOverlayOpacity: React.PropTypes.number,
   childrenStyle: View.propTypes.style,
-  foregroundParallaxRatio: React.PropTypes.number,
   fadeOutForeground: React.PropTypes.bool,
+  foregroundParallaxRatio: React.PropTypes.number,
+  maxHeight: React.PropTypes.number,
+  maxOverlayOpacity: React.PropTypes.number,
+  minHeight: React.PropTypes.number,
+  minOverlayOpacity: React.PropTypes.number,
+  renderForeground: React.PropTypes.func,
+  renderHeader: React.PropTypes.func,
   ...ScrollView.propTypes,
 };
 
 ImageHeaderScrollView.defaultProps = {
+  fadeOutForeground: false,
+  foregroundParallaxRatio: 1,
   maxHeight: 125,
-  minHeight: 80,
   maxOverlayOpacity: 0.3,
+  minHeight: 80,
   minOverlayOpacity: 0,
-  renderHeader: () => <View />,
   renderForeground: () => <View />,
-  foregroundParallaxRatio: 1,
-  fadeOutForeground: false,
+  renderHeader: () => <View />,
 };
 
 export default ImageHeaderScrollView;