update docs

This commit is contained in:
Thanasis Trispiotis 2023-04-21 01:38:20 +03:00
parent b2e68f5a8f
commit 1de71aa82b
No known key found for this signature in database
GPG Key ID: F2CB994F68ED0802
2 changed files with 26 additions and 26 deletions

View File

@ -1,33 +1,33 @@
<h1>
Tidal-hifi
<img src = "./build/icon.png" height="40" align="right" />
</h1>
# Tidal-hifi<img src = "./build/icon.png" height="40" align="right"/>
![GitHub release](https://img.shields.io/github/release/Mastermindzh/tidal-hifi.svg)
The web version of [listen.tidal.com](https://listen.tidal.com) running in electron with hifi support thanks to widevine.
![tidal-hifi preview](./docs/preview.png)
## Table of contents
## Table of Contents
<!-- toc -->
- [Table of contents](#table-of-contents)
- [Installation](#installation)
- [Tidal-hifi](#tidal-hifi)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Using releases](#using-releases)
- [Snap](#snap)
- [Arch Linux](#arch-linux)
- [Flatpak](#flatpak)
- [Nix](#nix)
- [Using source](#using-source)
- [Features](#features)
- [Integrations](#integrations)
- [Features](#features)
- [Integrations](#integrations)
- [Known bugs](#known-bugs)
- [last.fm doesn't work out of the box. Use rescrobbler as a workaround](#lastfm-doesnt-work-out-of-the-box-use-rescrobbler-as-a-workaround)
- [Why](#why)
- [Why not extend existing projects?](#why-not-extend-existing-projects)
- [Special thanks to...](#special-thanks-to)
- [Buy me a coffee? Please don't](#buy-me-a-coffee-please-dont)
- [Images](#images)
- [Why](#why)
- [Why not extend existing projects?](#why-not-extend-existing-projects)
- [Special thanks to...](#special-thanks-to)
- [Buy me a coffee? Please don't](#buy-me-a-coffee-please-dont)
- [Images](#images)
- [Settings window](#settings-window)
- [User setups](#user-setups)
@ -94,7 +94,7 @@ To install and work with the code on this project follow these steps:
- Notifications
- Custom hotkeys ([source](https://defkey.com/tidal-desktop-shortcuts))
- API for status and playback
- Block ads and enable video playback thanks to uBlock Origin custom filters (breakage is possible)
- Disabled audio & visual ads, unlocked lyrics, suggested track, track info, unlimited skips thanks to uBlockOrigin custom filters ([source](https://github.com/uBlockOrigin/uAssets/issues/17495))
- Custom [integrations](#integrations)
- [Settings feature](./docs/settings.png) to disable certain functionality. (`ctrl+=` or `ctrl+0`)
- AlbumArt in integrations ([best-effort](https://github.com/Mastermindzh/tidal-hifi/pull/88#pullrequestreview-840814847))

View File

@ -66,7 +66,7 @@
<div class="group__option">
<div class="group__description">
<h4>Block ads</h4>
<p>Enjoys ad-free playback with video feature enabled for free accounts.</p>
<p>Disabled audio & visual ads, unlocked lyrics, suggested track, track info, unlimited skips</p>
</div>
<label class="switch">
<input id="adBlock" type="checkbox">