diff --git a/README.md b/README.md index 08ef99b..c86a5bc 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,17 @@ -# Spotify Canvas Downloader -Tool to get Canvas cover videos from Spotify tracks. +# SPOTIFY-GUI +Control Spotify remotely with a nice and functional touchscreen interface -## ✨ [Try it out](https://canvastify.delitefully.com) +## ✨ [More info](https://stories.bbrunson.com/spotifygui-touchscreen-controller-for-spotify/) -### Building - +## Running +- Get a Spotify API Client ID and Secret from the [Spotify Developer Dashboard](https://developer.spotify.com/). Put these in the config.json file. - Clone the repository ```sh - git clone https://github.com/Delitefully/spotify-canvas-downloader + pip install -r requirements.txt ``` - Configure the env variables ```sh - mv env.example .env - ``` -- Build the image using Docker Compose - ```sh - docker-compose up - ``` - -### Development -Recompile protocol buffer proto (useful when upgrading protobuff): -``` -protoc ./protos/canvas.proto --python_out=./src/ -``` -Requires the [Protocol Buffers package](https://developers.google.com/protocol-buffers/docs/downloads). -### API - -```http -GET /api/canvas/:trackId -``` -Returns -```json -{ - "success": boolean - "canvas_url": string, if success is 'true' - "message": string, error message if success is 'false' -} -``` + python spotifycontroller.py + ``` \ No newline at end of file