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

chore(README): update README

Browse Source
This commit is contained in:
JellyBrick
2023-09-04 18:58:03 +09:00
parent 451d33707a
commit 563daae11a
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
readme.md
View File

@ -4,7 +4,7 @@
[![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 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)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=for-the-badge)](https://github.com/sindresorhus/xo)
[![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)
[![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/)
[![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)
[![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/)
@ -169,8 +169,8 @@ Some predefined themes are available in https://github.com/kerichdev/themes-for-
```sh
git clone https://github.com/th-ch/youtube-music
cd youtube-music
yarn
yarn start
npm
npm run start
```
## Build your own plugins
@ -231,12 +231,12 @@ module.exports = () => {
## Build
1. Clone the repo
2. Run `yarn` to install dependencies
3. Run `yarn build:OS`
2. Run `npm i` to install dependencies
3. Run `npm run build:OS`
- `yarn build:win` - Windows
- `yarn build:linux` - Linux
- `yarn build:mac` - MacOS
- `npm run build:win` - Windows
- `npm run build:linux` - Linux
- `npm run build:mac` - MacOS
Builds the app for macOS, Linux, and Windows,
using [electron-builder](https://github.com/electron-userland/electron-builder).
@ -244,7 +244,7 @@ using [electron-builder](https://github.com/electron-userland/electron-builder).
## Tests
```sh
yarn test
npm run test
```
Uses [Playwright](https://playwright.dev/) to test the app.