lostecho/ncspot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document authentication and stored credentials.

Browse Source
This commit is contained in:
Jake Zimmerman
2021-04-15 14:25:09 -07:00
committed by Henrik Friedrichsen
parent 9b3352c9e2
commit c44644db8a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -139,10 +139,13 @@ depending on your desktop environment settings. Have a look at the
Use `/` to open a Vim-like search bar, you can use `n` and `N` to go for the next/previous Use `/` to open a Vim-like search bar, you can use `n` and `N` to go for the next/previous
search occurrence, respectivly. search occurrence, respectivly.
### Commands
You can also open a Vim style commandprompt using `:`, the following commands You can also open a Vim style commandprompt using `:`, the following commands
are supported: are supported:
* `quit`: Quit ncspot * `quit`: Quit ncspot
* `logout`: Remove any cached credentials from disk and quit ncspot
* `toggle`: Toggle playback * `toggle`: Toggle playback
* `stop`: Stop playback * `stop`: Stop playback
* `previous`/`next`: Play previous/next track * `previous`/`next`: Play previous/next track
@@ -247,3 +250,11 @@ To allow scaling the album art up beyond its resolution (640x640 for Spotify cov
``` ```
cover_max_scale = 2 cover_max_scale = 2
``` ```
### Authentication
`ncspot` prompts for a Spotify username and password on first launch, uses this to generate an OAuth token, and stores it to disk.
The credentials are stored in `~/.cache/ncspot/librespot/credentials.json` (unless the base path has been changed with the `--basepath` option).
The `:logout` command can be used to programmatically remove cached credentials (see [Commands](#commands) above).