diff --git a/README.md b/README.md index 329020e..d527d3f 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,16 @@ the Vimeo player JS API (more information https://developer.vimeo.com/player/js- 'waiting' ``` +## Available Props + +| Name | Type | Default | Description | +| ------------ | ------------------------ | --------- | -------------------------------------------------------------------------------- | +| `handlers` | `{ [key: string]: any }` | {} | Listeners to be attached in the Vimeo Player | +| `videoId` | `string` | undefined | The video id which will be rendered | +| `params` | `string` | undefined | Extra params to be attached on the vimeo player url | +| `reference` | `string` | undefined | In order to support private videos you can specify the reference prop | +| `otherProps` | `WebViewProps` | {} | To customize the webview that wraps the player, you can specify additional props | + ## Example If you want to see `MetaLabs-inc/react-native-vimeo-iframe` in action, just move into the [example](/example) folder and run `yarn && cd ios && pod install && cd .. && yarn ios` or `yarn && yarn android`. By seeing its source code, you will have a better understanding of the library usage. @@ -73,6 +83,8 @@ If you want to see `MetaLabs-inc/react-native-vimeo-iframe` in action, just move