smueller/youtube-music
1
0
Fork 0
mirror of https://github.com/th-ch/youtube-music.git synced 2026-01-11 10:31:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
JellyBrick
2023-10-01 12:25:53 +09:00
committed by GitHub
parent faaf54d0b0
commit 10049d1ee9
1 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
readme.md
View File

@ -2,12 +2,12 @@
<div align="center"> <div align="center">
[![GitHub release](https://img.shields.io/github/release/th-ch/youtube-music.svg?style=for-the-badge&logo=youtube-music)](https://github.com/th-ch/youtube-music/releases/) [![GitHub release](https://img.shields.io/github/release/organization/youtube-music-next.svg?style=for-the-badge&logo=youtube-music)](https://github.com/organization/youtube-music-next/releases/)
[![GitHub license](https://img.shields.io/github/license/th-ch/youtube-music.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/LICENSE) [![GitHub license](https://img.shields.io/github/license/organization/youtube-music-next.svg?style=for-the-badge)](https://github.com/organization/youtube-music-next/blob/master/LICENSE)
[![eslint code style](https://img.shields.io/badge/code_style-eslint-5ed9c7.svg?style=for-the-badge)](https://github.com/th-ch/youtube-music/blob/master/.eslintrc.js) [![eslint code style](https://img.shields.io/badge/code_style-eslint-5ed9c7.svg?style=for-the-badge)](https://github.com/organization/youtube-music-next/blob/master/.eslintrc.js)
[![Build status](https://img.shields.io/github/actions/workflow/status/th-ch/youtube-music/build.yml?branch=master&style=for-the-badge&logo=youtube-music)](https://GitHub.com/th-ch/youtube-music/releases/) [![Build status](https://img.shields.io/github/actions/workflow/status/organization/youtube-music-next/build.yml?branch=custom-version&style=for-the-badge&logo=youtube-music)](https://github.com/organization/youtube-music-next/releases/)
[![Known Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/th-ch/youtube-music?style=for-the-badge)](https://snyk.io/test/github/th-ch/youtube-music) [![Known Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/organization/youtube-music-next?style=for-the-badge)](https://snyk.io/test/github/organization/youtube-music-next)
[![GitHub All Releases](https://img.shields.io/github/downloads/th-ch/youtube-music/total?style=for-the-badge&logo=youtube-music)](https://GitHub.com/th-ch/youtube-music/releases/) [![GitHub All Releases](https://img.shields.io/github/downloads/organization/youtube-music-next/total?style=for-the-badge&logo=youtube-music)](https://github.com/organization/youtube-music-next/releases/)
[![AUR](https://img.shields.io/aur/version/youtube-music-bin?color=blueviolet&style=for-the-badge&logo=youtube-music)](https://aur.archlinux.org/packages/youtube-music-bin) [![AUR](https://img.shields.io/aur/version/youtube-music-bin?color=blueviolet&style=for-the-badge&logo=youtube-music)](https://aur.archlinux.org/packages/youtube-music-bin)
</div> </div>
@ -28,7 +28,7 @@
## Download ## Download
You can check out the [latest release](https://github.com/th-ch/youtube-music/releases/latest) to quickly find the You can check out the [latest release](https://github.com/organization/youtube-music-next/releases/latest) to quickly find the
latest version. latest version.
### Arch Linux ### Arch Linux
@ -40,7 +40,7 @@ this [wiki page](https://wiki.archlinux.org/index.php/Arch_User_Repository#Insta
If you get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal: If you get an error "is damaged and can’t be opened." when launching the app, run the following in the Terminal:
``` ```bash
xattr -cr /Applications/YouTube\ Music.app xattr -cr /Applications/YouTube\ Music.app
``` ```
@ -49,7 +49,7 @@ xattr -cr /Applications/YouTube\ Music.app
You can use the [Scoop package manager](https://scoop.sh) to install the `youtube-music` package from You can use the [Scoop package manager](https://scoop.sh) to install the `youtube-music` package from
the [`extras` bucket](https://github.com/ScoopInstaller/Extras). the [`extras` bucket](https://github.com/ScoopInstaller/Extras).
``` ```bash
scoop bucket add extras scoop bucket add extras
scoop install extras/youtube-music scoop install extras/youtube-music
``` ```
@ -61,7 +61,7 @@ official CLI package manager to install the `th-ch.YouTubeMusic` package.
true for the manual installation when trying to run the executable(.exe) after a manual download here on github (same true for the manual installation when trying to run the executable(.exe) after a manual download here on github (same
file).* file).*
``` ```bash
winget install th-ch.YouTubeMusic winget install th-ch.YouTubeMusic
``` ```
@ -166,7 +166,7 @@ Some predefined themes are available in https://github.com/kerichdev/themes-for-
## Dev ## Dev
```sh ```bash
git clone https://github.com/th-ch/youtube-music git clone https://github.com/th-ch/youtube-music
cd youtube-music cd youtube-music
npm npm
@ -184,18 +184,18 @@ Using plugins, you can:
Create a folder in `plugins/YOUR-PLUGIN-NAME`: Create a folder in `plugins/YOUR-PLUGIN-NAME`:
- if you need to manipulate the BrowserWindow, create a file `back.js` with the following template: - if you need to manipulate the BrowserWindow, create a file `back.ts` with the following template:
```node ```typescript
module.exports = win => { export default (win: Electron.BrowserWindow) => {
// win is the BrowserWindow object // something
}; };
``` ```
- if you need to change the front, create a file `front.js` with the following template: - if you need to change the front, create a file `front.ts` with the following template:
```node ```typescript
module.exports = () => { export default () => {
// This function will be called as a preload script // This function will be called as a preload script
// So you can use front features like `document.querySelector` // So you can use front features like `document.querySelector`
}; };
@ -205,21 +205,21 @@ module.exports = () => {
- injecting custom CSS: create a `style.css` file in the same folder then: - injecting custom CSS: create a `style.css` file in the same folder then:
```node ```typescript
const path = require("path"); import path from 'node:path';
const {injectCSS} = require("../utils"); import { injectCSS } from '../utils';
// back.js // back.ts
module.exports = win => { export default (win: Electron.BrowserWindow) => {
injectCSS(win.webContents, path.join(__dirname, "style.css")); injectCSS(win.webContents, path.join(__dirname, 'style.css'));
}; };
``` ```
- changing the HTML: - changing the HTML:
```node ```typescript
// front.js // front.ts
module.exports = () => { export default () => {
// Remove the login button // Remove the login button
document.querySelector(".sign-in-link.ytmusic-nav-bar").remove(); document.querySelector(".sign-in-link.ytmusic-nav-bar").remove();
}; };
@ -243,7 +243,7 @@ using [electron-builder](https://github.com/electron-userland/electron-builder).
## Tests ## Tests
```sh ```bash
npm run test npm run test
``` ```