-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update README.md to reflect rebranding and additional information
- Loading branch information
1 parent
38ff717
commit 4b91eae
Showing
3 changed files
with
28 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,30 @@ | ||
<h1 align="center"> | ||
<img src="icons/icon128.png" alt="HoloSongs icon" /><br /> | ||
HoloSongs | ||
</h1> | ||
<div align="center"> | ||
|
||
![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) | ||
|
||
</div> | ||
|
||
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 [email protected]:themintchoco/youtube-holodex.git | ||
cd youtube-holodex | ||
git clone [email protected]: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. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.