diff --git a/README.md b/README.md index 87002b8..75048ab 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # Plyx-Player +> Currently in beta stages. + +## Installing +The Plyx Player is available to download from SudoVanilla's registry, run: +```bash +npm set registry https://packages.sudovanilla.com/ +``` +(This registry is also a proxy for NPM) + +Then, for your project, install Plyx: +```bash +npm install @sudovanilla/plyx-player +``` + +## Usage +Add the stylesheet and script: +```html +... + +