From be8dda6afc5efd36a8ed9e4dd08cfbeea29ec6ac Mon Sep 17 00:00:00 2001 From: Asher Morgan <59518073+ashermorgan@users.noreply.github.com> Date: Sat, 20 Apr 2024 10:03:39 -0700 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 933e2b3..144616e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,22 @@ # Songs2Slides -An easy-to-use tool that automatically finds song lyrics and creates lyric slideshows +A tool that automatically finds song lyrics and creates lyric slideshows ## Setup -1. Install python dependencies +Install Python dependencies: ``` python3 -m pip install -r requirements.txt ``` -2. Add variables to `.env` file +Add API environment variables to a `.env` file: ``` +# Song lyric API with {title} and {artist} placeholders API_URL="http://example.com/get-lyrics?title={title}&artist={artist}" -API_AUTH="Bearer secrettoken" # Optional + +# Optional API authentication header +API_AUTH="Bearer secrettoken" ``` -3. Run app in debug mode +Run Songs2Slides on [localhost:5000](http://localhost:5000) ``` -flask --app songs2slides run --debug +flask --app songs2slides run ``` - -4. Visit [localhost:5000](http://localhost:5000)