diff --git a/README.md b/README.md index 935598c..58da377 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,120 @@ # Zorn -A custom video player tailored for MinPluto. \ No newline at end of file +![Zorn using Milieu Mode](https://md.sudovanilla.org/images/Screenshot%20from%202024-08-16%2016-16-48.png) + +A custom video player tailored for MinPluto. + +## Installation +To install Zorn for your Astro project, run the following: + +```bash +bun install @minpluto/zorn --registry https://npm.sudovanilla.org +``` + +Zorn uses icons from Iconoir using their Vue package, you'll need to integrate Astro's Vue package if you want to use the custom controls. + +Learn how: https://docs.astro.build/en/guides/integrations-guide/vue/#manual-install + +## Examples +**Basic Usage** + +Import `Zorn` from the package and add it to your page. + +```jsx +--- +import {Zorn} from '@minpluto/zorn' +--- + + +``` + +**With Separated Audio Source** + +Since Zorn is built for the MinPluto project, there are scenarios where the video source has no audio to get higher quality options, so Zorn has an opion to add a seprated audio source to include. + +```jsx +--- +import {Zorn} from '@minpluto/zorn' +--- + + +``` + +Make sure to add `muted` to the `VideoAttributes` option, just in case. + +## References +**Poster** - `Poster` + +Setting a thumbnail for the video player is done using the [`poster`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#poster) attribute. Just use a valid URL. + +```jsx +Poster="https://example.org/media/thumbnail.webp" +``` + +**Video Source** - `Video` + +The main part of the video player, is of course the video. You can set any video source you want, local or remote. + +Local: +```jsx +Video="/media/video.webm" +``` +> Use the `/public/` folder in your Astro project. + +Remote: +```jsx +Video="https://example.org/media/video.webm" +``` + +**Audio Source** - `Audio` + +If you're in a scenario where the video source is missing audio, but you do have the audio itself, you can add that audio source to the video player. A separated `