Skip to content

Commit d680ac2

Browse files
committed
Updated README and conf.properties
1 parent a7b18bb commit d680ac2

2 files changed

Lines changed: 10 additions & 15 deletions

File tree

README.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
`librespot-java` is a port of [librespot](https://github.com/librespot-org/librespot), originally written in Rust. Additionally, this implementation provides an useful API to request metadata or control the player, more [here](https://github.com/librespot-org/librespot-java/blob/master/api).
66

77
## Get started
8-
This implementation doesn't have an user interface (at the moment) therefore you can interact with it only from an original Spotify client. To understand how you can use this have a look at the [Main.java](https://github.com/librespot-org/librespot-java/blob/master/core/src/main/java/org/librespot/spotify/Main.java), there you can decide how to authenticate:
8+
All the configuration you need is inside the `conf.properties` file, there you can decide to authenticate with:
99
- Username and password
1010
- Zeroconf
1111
- Facebook
@@ -24,12 +24,7 @@ Authenticate with Facebook. The console will provide a link to visit in order to
2424
This is more advanced and should only be used if you saved an authentication blob. The blob should have already been Base64-decoded.
2525

2626
## Run
27-
After you've setup the [Main class](https://github.com/librespot-org/librespot-java/blob/master/core/src/main/java/org/librespot/spotify/Main.java), you can proceed and compile the project. Install [Maven](https://maven.apache.org/) and run `mvn clean package` in the project root, if the compilation succeeds you'll be pleased with a JAR executable in `core/target`. Remember that you need to clone the project with its submodules (`git clone --recursive https://github.com/librespot-org/librespot-java`).
28-
29-
## TODO
30-
The client is pretty functional as it is, but improvements can be made:
31-
- Have an user interface
32-
- API (WIP)
33-
- ~API client~ ([librespot-api](https://github.com/librespot-org/librespot-java/blob/master/api))
34-
- ~Caching~ (#18)
35-
- ~Preloading~ (#21)
27+
To run the program type `java -jar ./core/target/librespot-core-jar-with-dependencies.jar` from the project root folder.
28+
29+
## Build it
30+
This project uses [Maven](https://maven.apache.org/), after installing it you can compile with `mvn clean package` in the project root, if the compilation succeeds you'll be pleased with a JAR executable in `core/target`. Remember that you need to clone the project with its submodules (`git clone --recursive https://github.com/librespot-org/librespot-java`).

conf.properties

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ deviceName=librespot-java
44
deviceType=Computer
55
# Authentication
66
## Strategy (USER_PASS, ZEROCONF, BLOB, FACEBOOK)
7-
auth.strategy=zeroconf
8-
## Spotify username (BLOB, USER_PASS)
7+
auth.strategy=ZEROCONF
8+
## Spotify username (BLOB, USER_PASS only)
99
auth.username=
10-
## Spotify password (USER_PASS)
10+
## Spotify password (USER_PASS only)
1111
auth.password=
12-
## Spotify authentication blob (BLOB)
12+
## Spotify authentication blob (BLOB only)
1313
auth.blob=
14-
## Cache enabled
14+
# Cache enabled
1515
cache.enabled=false
1616
# Zeroconf
1717
## Listen on all interfaces (overrides `zeroconf.interfaces`)

0 commit comments

Comments
 (0)