From a4acb8a8738b4ffe6a58b5f8cfe617b91e077019 Mon Sep 17 00:00:00 2001 From: froge Date: Wed, 12 Feb 2025 12:00:02 +1000 Subject: [PATCH] Update README with docker instructions --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8e6ec5..bad3e13 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This API supports simple artist read operations for spotify data, as well as using a simple caching database and handling client authentication automatically. ## Setup -After compiling the binary, or when executing via `go run`, just be sure to set the following environment variables to enable access to Spotify's API +After compiling the binary, or when executing via `go run`, just be sure to set the following environment variables to enable access to Spotify's API. ``` SPOTIFY_ID= SPOTIFY_TOKEN= @@ -14,8 +14,11 @@ Example execution using the linux command line: Alternatively you can use `go run` too: `SPOTIFY_ID=myspotifyID SPOTIFY_TOKEN=myspotifytoken go run .` +This project has been built with docker support, and a docker image can be built using the Dockerfile provided. +Please note that the above environment variables will still need to be passed into the container for execution to work correctly. + ## Testing -This application comes with a complete test suite, it can be run using the standard `go test` system +This application comes with a complete test suite, it can be run using the standard `go test` system. When running tests you are required to provide the same credentials as when running the server normally. For example: