Add some comments about props to the README

This commit is contained in:
Brent Vatne 2015-04-07 20:44:06 -07:00
parent fccfdbfd30
commit e285ca9a1d

View File

@ -27,8 +27,14 @@ A <Video> component for react-native, as seen in
// Within your render function, assuming you have a file called // Within your render function, assuming you have a file called
// "background.mp4" in your project. You can include multiple videos // "background.mp4" in your project. You can include multiple videos
// on a single screen if you like. // on a single screen if you like.
<Video source={"background"} style={styles.backgroundVideo} <Video source={"background"} // Can be a URL or a local file
resizeMode="cover" repeat={true} /> rate={1.0} // 0 is paused, 1 is normal.
volume={1} // 0 is muted, 1 is normal.
muted={false} // Mutes the audio entirely.
paused={false} // Pauses playback entirely.
resizeMode="cover" // Fill the whole screen at aspect ratio
repeat={true} // Repeat forever
style={styles.backgroundVideo} />
// Later on in your styles.. // Later on in your styles..
var styles = Stylesheet.create({ var styles = Stylesheet.create({