diff --git a/README.md b/README.md index 27dc170..08ecfb0 100644 --- a/README.md +++ b/README.md @@ -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 +
+ +
+``` + +```javascript +const videoElement = document.getElementById('video-element'); +const pgsRenderer = new libpgs.PgsRenderer({ + video: videoElement, + subUrl: './subtitle.sup' +}); +``` + +## Licence + +[MIT License](LICENSE)