From aa69364880d7686fa81da68f58fb22bed2d0498f Mon Sep 17 00:00:00 2001 From: MrUnknownDE Date: Sun, 28 Dec 2025 18:00:10 +0100 Subject: [PATCH] docs: Add GitHub badge, improve setup instructions in README, and ignore cache directory. --- .gitignore | 5 ++++- README.md | 15 ++++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 3224a90..282400d 100644 --- a/.gitignore +++ b/.gitignore @@ -141,4 +141,7 @@ dist # SvelteKit build / generate output .svelte-kit -# End of https://www.toptal.com/developers/gitignore/api/node \ No newline at end of file +# End of https://www.toptal.com/developers/gitignore/api/node + +# Application cache (analysis jobs and search results) +cache/ \ No newline at end of file diff --git a/README.md b/README.md index b46f3d5..e078925 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Spotify to YouTube Music Migration Tool +[![GitHub](https://img.shields.io/badge/GitHub-MrUnknownDE%2Fsptify2yt-blue?logo=github)](https://github.com/MrUnknownDE/sptify2yt) + A Node.js web application that migrates your Spotify playlists to YouTube Music with a preview and review workflow. ## ✨ Features @@ -39,7 +41,8 @@ A Node.js web application that migrates your Spotify playlists to YouTube Music ### Option 1: Local Development ```bash -# Clone and enter directory +# Clone the repository +git clone https://github.com/MrUnknownDE/sptify2yt.git cd sptify2yt # Install dependencies @@ -58,16 +61,26 @@ Open http://localhost:3000 in your browser. ### Option 2: Docker ```bash +# Clone the repository +git clone https://github.com/MrUnknownDE/sptify2yt.git +cd sptify2yt + # Copy and configure environment cp .env.example .env nano .env # Build and run docker compose up -d + +# View logs (optional) +docker compose logs -f ``` Open http://localhost:3000 in your browser. +To stop: `docker compose down` + + ## ⚙️ Configuration All settings are configured via environment variables (`.env` file):