From 052b6139c656ea54ad71c45e75a4db8f9f6d739d Mon Sep 17 00:00:00 2001 From: David Schulte Date: Sun, 9 Jun 2024 16:23:52 +0200 Subject: [PATCH] Updated `README.md`. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) 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)