new version + readme updates

This commit is contained in:
Rick van Lieshout 2021-04-25 18:32:52 +02:00
parent b7f163c1a1
commit d34ddfeb75
5 changed files with 4368 additions and 31 deletions

View File

@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## 2.2.0
- The discord integration now adds a time remaining field based on the song duration
- All fields (current, remaining, and url are also available in the API*)
- the artist field is now correctly identified
* current time only updates on play/pause.
## 2.1.1
- The discord integration now doesn't send an update every 15 seconds it sends an update whenever the media info changes

View File

@ -18,6 +18,7 @@ The web version of [listen.tidal.com](listen.tidal.com) running in electron with
- [Using source](#using-source)
- [features](#features)
- [Integrations](#integrations)
- [not included](#not-included)
- [Known bugs](#known-bugs)
- [Why](#why)
- [Why not extend existing projects?](#why-not-extend-existing-projects)
@ -39,13 +40,13 @@ Various packaged versions of the software are available on the [releases](https:
To install with `snap` you need to download the pre-packaged snap-package from this repository, found under releases:
1. Download:
1. Download
```sh
wget <URI> #for instance: https://github.com/Mastermindzh/tidal-hifi/releases/download/1.0/tidal-hifi_1.0.0_amd64.snap
```
2. Install:
2. Install
```sh
snap install --dangerous <path> #for instance: tidal-hifi_1.0.0_amd64.snap
@ -63,7 +64,7 @@ trizen tidal-hifi
To install and work with the code on this project follow these steps:
- git clone https://github.com/Mastermindzh/tidal-hifi.git
- git clone [https://github.com/Mastermindzh/tidal-hifi.git](https://github.com/Mastermindzh/tidal-hifi.git)
- cd tidal-hifi
- npm install
- npm start
@ -74,10 +75,23 @@ 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
- Custom [integrations](#integrations)
- [Settings feature](./docs/settings.png) to disable certain functionality. (`ctrl+=`)
## Integrations
Tidal-hifi comes with several integrations out of the box.
You can find these in the settings menu (`ctrl + =` by default) under the "integrations" tab.
![integrations menu, showing a list of integrations](./docs/integrations.png)
It currently includes:
- mpris - mpris media player controls/status
- Discord - Shows what you're listening to on Discord.
### not included
- [i3 blocks config](https://github.com/Mastermindzh/dotfiles/commit/9714b2fa1d670108ce811d5511fd3b7a43180647) - My dotfiles where I use this app to fetch currently playing music (direct commit)
### Known bugs

BIN
docs/integrations.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

4363
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{
"name": "tidal-hifi",
"version": "2.1.1",
"version": "2.2.0",
"description": "Tidal on Electron with widevine(hifi) support",
"main": "src/main.js",
"scripts": {
@ -33,11 +33,11 @@
},
"devDependencies": {
"@mastermindzh/prettier-config": "^1.0.0",
"dot-prop": ">=4.2.1",
"electron": "git+https://github.com/castlabs/electron-releases.git#v10.4.3-wvvmp",
"electron-builder": "^21.2.0",
"electron-reload": "^1.5.0",
"prettier": "^2.0.4",
"dot-prop": ">=4.2.1"
"prettier": "^2.0.4"
},
"prettier": "@mastermindzh/prettier-config"
}