Skip to content

Commit a6b6e79

Browse files
committed
Update README.md to clarify usage of storeCredentials
1 parent 427d995 commit a6b6e79

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Its main features are:
2020
- Mixed playlists (cuepoints and transitions)
2121

2222
## Get started
23-
All the configuration you need is inside the `config.toml` file, there you can decide to authenticate with:
23+
All the configuration you need is inside the `config.toml` file. If none is present, a sample `config.toml` will be generated the first time the jar is run. There you can decide to authenticate with:
2424
- Username and password
2525
- Zeroconf
2626
- Facebook
@@ -38,7 +38,10 @@ If you have a firewall, you need to open the UDP port `5355` for mDNS. Then spec
3838
Authenticate with Facebook. The console will provide a link to visit in order to continue the login process.
3939

4040
### Auth blob
41-
This is more advanced and should only be used if you saved an authentication blob. The blob should have already been Base64-decoded.
41+
This is more advanced and should only be used if you saved an authentication blob. The blob should have already been Base64-decoded. Generating one is currently not a feature of librespot-java
42+
43+
### Storing credentials
44+
If the configurations `storeCredentials=true` and `credentialsFile="somepath.json"` have been set, the credentials will be saved in a more secure format inside the json file. After having run the application once and successfully authenticating, the authentication config fields above are no longer needed and should be made blank for security purposes.
4245

4346
## Run
4447
You can download the latest release from [here](https://github.com/librespot-org/librespot-java/releases) and then run `java -jar ./librespot-core-jar-with-dependencies.jar` from the command line.

0 commit comments

Comments
 (0)