Skip to content

Commit

Permalink
Readme update (#6)
Browse files Browse the repository at this point in the history
* v1.1.0

* v1.1.1

* [readme] update manual usages
  • Loading branch information
mkhuda authored Aug 25, 2021
1 parent d7b0ad7 commit c4459e3
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 9 deletions.
46 changes: 39 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react-shaka-player (Work In Progress) [![Build Status](https://app.travis-ci.com/mkhuda/react-shaka-player.svg?branch=main)](https://app.travis-ci.com/mkhuda/react-shaka-player)
# @mkhuda/react-shaka-player [![Build Status](https://app.travis-ci.com/mkhuda/react-shaka-player.svg?branch=main)](https://app.travis-ci.com/mkhuda/react-shaka-player) [![npm version](https://badge.fury.io/js/%40mkhuda%2Freact-shaka-player.svg)](https://badge.fury.io/js/%40mkhuda%2Freact-shaka-player)

React video player built with [Shaka Player](https://github.com/google/shaka-player).
React video player built with [Shaka Player](https://github.com/google/shaka-player). [ROADMAP](https://github.com/mkhuda/react-shaka-player/wiki/Initial-Roadmap)

## Installation

Expand All @@ -17,19 +17,51 @@ npm install @mkhuda/react-shaka-player
## Usage

```javascript
import Player from "@mkhuda/react-shaka-player"
import "shaka-player/dist/controls.css";
import Player from "@mkhuda/react-shaka-player";

function App() {
return(
<Player autoPlay={true} src={"https://yourvideohere.mpd"} />
);
return <Player autoPlay={true} src={"https://yourvideohere.mpd"} />;
}
```

## Manual Handle Usage

```javascript
function App() {
let [mainPlayer, setMainPlayer] = useState({});

useEffect(() => {
const { player, videoElement } = mainPlayer;

if (player) {
async function play() {
await player.load("https://yourvideomaster.mpd");
videoElement.play();
}
play();
}
}, [mainPlayer]);

return (
<div className="App">
<div className="App-main">
<ReactShakaPlayer
playerClassName="player-class-name"
onLoad={(player) => setMainPlayer(player)}
/>
</div>
</div>
);
}
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)

[MIT](https://choosealicense.com/licenses/mit/)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mkhuda/react-shaka-player",
"version": "1.1.0",
"version": "1.1.1",
"description": "React video player built with Shaka-Player",
"main": "dist/cjs.js",
"author": "Muhammad K. Huda",
Expand Down Expand Up @@ -78,4 +78,4 @@
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
}

0 comments on commit c4459e3

Please sign in to comment.