Skip to content

Commit be7f882

Browse files
committed
Add more usage instructions including docker
1 parent 246e1dd commit be7f882

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,32 @@ Environment Variables
5252

5353
## Usage
5454

55+
Output is provided to stdout/stderr as well as file if specified in configuration.
56+
57+
On first startup you may need to authroize Spotify by visiting a callback URL. The default url to open is:
58+
59+
```
60+
https://localhost:9078/authSpotify
61+
```
62+
63+
### Running Directly
64+
5565
```
5666
node index.js
5767
```
5868

59-
Output is provided to stdout/stderr as well as file if specified in configuration
69+
### Docker
6070

71+
[Docker repository](https://hub.docker.com/repository/docker/foxxmd/spotify-scrobbler)
72+
```
73+
foxxmd/spotify-scrobbler:latest
74+
```
75+
76+
Minimal configuration requires you to bind a host directory for the configuration directory in the container:
77+
78+
```
79+
docker run ... -v /path/on/host/config:/home/node/config ...
80+
```
6181

6282
## License
6383

0 commit comments

Comments
 (0)