Updated README.md.

This commit is contained in:
David Schulte
2024-06-09 16:23:52 +02:00
parent 2489e53967
commit 052b6139c6
+27
View File
@@ -1 +1,28 @@
# libpgs-js
This library renders the graphical subtitles format PGS _(.sub / .sup)_ in the browser.
## Usage
Install the package via npm:
```
npm i --save libpgs
```
```html
<div style="position: relative">
<video id="video-element" src="./video.mp4"></video>
</div>
```
```javascript
const videoElement = document.getElementById('video-element');
const pgsRenderer = new libpgs.PgsRenderer({
video: videoElement,
subUrl: './subtitle.sup'
});
```
## Licence
[MIT License](LICENSE)