diff --git a/README.md b/README.md index 8af632d..6c3458e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ -

- HoloSongs icon
- HoloSongs -

+
+ +![HoloSongs icon](docs/img/Icon.png) + +# HoloSongs + +[![Build status](https://img.shields.io/github/actions/workflow/status/themintchoco/holosongs/release.yml?style=for-the-badge)](https://github.com/themintchoco/holosongs/actions/workflows/release.yml) +[![Latest release](https://img.shields.io/github/v/release/themintchoco/holosongs?label=Latest%20release&style=for-the-badge)](https://github.com/themintchoco/holosongs/releases) +[![Chrome Web Store](https://img.shields.io/chrome-web-store/v/ipibfcnlipdkimfmajnddpboejkocplf?style=for-the-badge)](https://chrome.google.com/webstore/detail/holosongs/ipibfcnlipdkimfmajnddpboejkocplf) + +
Powered by the global Holodex community, HoloSongs (previously youtube-holodex) is a Chrome extension that adds a full featured media player to long YouTube livestreams so you can seek to your favorite songs and play them on repeat. ![HoloSongs screenshot](docs/img/Songs.png) +## Features + +Get a full featured media player alongside singing streams + +- Setlist at a glance +- Seek and skip individual songs +- Repeat modes +- Music mode (skips talking segments) + +Works with most videos from your favorite streamers, including streamers from Hololive, Nijisanji and other organizations. + ## Usage To get started, retrieve your API key from your [account settings](https://holodex.net/login) and paste it into the extension settings. @@ -15,16 +33,18 @@ To get started, retrieve your API key from your [account settings](https://holod ### Chrome Web Store -Coming soon! +[![Available on the Chrome Web Store](docs/img/ChromeWebStore.png)](https://chrome.google.com/webstore/detail/holosongs/ipibfcnlipdkimfmajnddpboejkocplf) + +The easiest method of installation. Simply click on the above image and then on *Add to Chrome*. ### Build from source ```bash -git clone git@github.com:themintchoco/youtube-holodex.git -cd youtube-holodex +git clone git@github.com:themintchoco/holosongs.git +cd holosongs npm install npm run build ``` -To complete installation, enable developer mode on the Chrome extensions page and click Load Unpacked. Then select the `dist/` directory created during the build. +To complete installation, enable developer mode on the Chrome extensions page and click *Load Unpacked*. Then select the `dist/` directory created during the build. diff --git a/docs/img/ChromeWebStore.png b/docs/img/ChromeWebStore.png new file mode 100644 index 0000000..4e48b8a Binary files /dev/null and b/docs/img/ChromeWebStore.png differ diff --git a/docs/img/Icon.png b/docs/img/Icon.png new file mode 100644 index 0000000..0deff45 Binary files /dev/null and b/docs/img/Icon.png differ