railbird/react-native-video
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme updates

Browse Source 
- Add warning and link to documentation for 5.2.x
- Explain how to install version 6 from npm
This commit is contained in:
Liam Potter 2022-09-28 20:45:49 +01:00 committed by GitHub
parent 9501d43357
commit 1e06c67764
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,15 +1,27 @@
# react-native-video
#### A `<Video>` component for react-native.
> :warning: **Version 6 Alpha**: The following documentation may refer to features only available through the v6.0.0 alpha releases, [please see version 5.2.x](https://github.com/react-native-video/react-native-video/blob/v5.2.0/README.md) for the current documentation!
Version 6.x recommends react-native >= 0.68.2. For older versions of react-native, [please use version 5.x](https://github.com/react-native-video/react-native-video/tree/v5.2.0).
## A `<Video>` component for react-native.
Version 6.x recommends react-native >= 0.68.2.
<br>For older versions of react-native, [please use version 5.x](https://github.com/react-native-video/react-native-video/tree/v5.2.0).
### Version 6.0.0 breaking changes
Version 6.0.0 is introducing dozens of breaking changes, mostly through updated dependecies and significant refactoring. While the API remains compatible, the significant internal changes require full testing with your app to ensure all functionality remains operational. Please view the [Changelog](CHANGELOG.md) for specific breaking changes.
## Useful resources
### Installing Version 6.0.0 Alphas
Whilst we finalise version 6.0.0 you can installed the latest alpha from npm
Using npm:
```
npm install --save react-native-video@alpha
```
using yarn:
```
yarn add react-native-video@alpha
```
## Useful resources
- [Documentation](API.md)
- [Changelog](CHANGELOG.md)
- [Contribution guide](CONTRIBUTING.md)