From 46b294cf0176f89722715f5b61e59703bbb83e6d Mon Sep 17 00:00:00 2001 From: Wesley Kerfoot Date: Sat, 20 Apr 2019 12:47:56 -0400 Subject: [PATCH] Add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b59412 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +## Usage + +### Please note that this won't work without Spotify Premium because Spotify limits web API access to non-free accounts. + +* Go to [https://developer.spotify.com/dashboard/applications](https://developer.spotify.com/dashboard/applications) and create an application. Call it whatever you want. + +* Create a `.env` or `.envrc` file with contents like this, put it wherever you + want. + +``` +export SPOTIPY_CLIENT_ID='YOUR_CLIENT_ID' +export SPOTIPY_CLIENT_SECRET='YOUR_CLIENT_SECRET' +export SPOTIPY_REDIRECT_URI='http://localhost' +export SPOTIFY_USERNAME='YOUR_SPOTIFY_USERNAME' +``` + +* You can find the values for `SPOTIPY_CLIENT_ID` and `SPOTIPY_CLIENT_SECRET` + on the page for your application that you just created. + +* You can find your spotify username [here](https://www.spotify.com/us/account/overview/) + +* Now you can run `spotify-mpd-sync` with your `.env` file sourced (e.g. `source .env`)