Skip to content

chore: update readme #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rj-wowza merged 2 commits into from
Jan 28, 2025
Merged

chore: update readme #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9016c93
chore: update readme
rj-wowza Jan 28, 2025
1b5ade5
chore: change badge color to react bleu
rj-wowza Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# react-flowplayer
Flowplayer React Component
![React version](https://img.shields.io/badge/react->=17.0.2-58c4dc?style=flat)
[![NPM version](https://img.shields.io/npm/v/@flowplayer/react-flowplayer.svg?style=flat)](https://npmjs.com/package/@flowplayer/react-flowplayer)
[![NPM downloads](https://img.shields.io/npm/dm/@flowplayer/react-flowplayer.svg?style=flat)](https://npmjs.com/package/@flowplayer/react-flowplayer)

<br>
<div>
<a href="https://www.wowza.com">
<img src="./logo.svg" width="640">
</a>
</div>
<br>

**react-flowplayer** is the preferred way to use Flowplayer with the React framework.

### Resources
<!-- [Documentation](https://developer.wowza.com/docs/wowza-flowplayer/guides/add-the-player-using-typescript.md/) -->
* [Examples and Guides](https://developer.wowza.com/docs/wowza-flowplayer/player/embed/embed-with-standalone/#use-npm)
Copy link

@sdvassil sdvassil Jan 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rj-wowza @ondreian For the React docs, maybe we should link to this instead? https://developer.wowza.com/docs/wowza-flowplayer/player/components/react/

It's definitely not wonderful, but all we got at the moment.

* [Releases](https://github.com/flowplayer/react-flowplayer/releases)
* [Support](https://www.wowza.com/support)




Documentation exists on [flowplayer.com developer area](https://flowplayer.com/developers/player/react)
14 changes: 14 additions & 0 deletions logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading