-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a2ffb36
commit bec774b
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,22 @@ | ||
# Videoary | ||
|
||
Videoary is a simple video player build with Typescript. | ||
|
||
To use Videoary | ||
```js | ||
import { Videoary } from "videoary" | ||
|
||
const videoary = new Videoary({ | ||
containerArea: container, | ||
video: { | ||
src: "example", // The extension must be .mp4 | ||
poster: null // Poster or thumbnail extension must be .png | ||
}, | ||
subtitles: [ | ||
{ | ||
short: "en", | ||
long: "English" | ||
} | ||
] | ||
}) | ||
``` |