diff --git a/README.md b/README.md index 1cc9beb..782eeb1 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,25 @@ -## a frontend to yt-dlp +## scaricatore ![version](https://git.pweapon.org/odo/dl.emersa.it/badges/release.svg "version") ![status](https://git.pweapon.org/odo/dl.emersa.it/badges/workflows/ci.yaml/badge.svg "status") -It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things from the web. +![image](./static/screen.webp "screen") -- `youtube-dl-exec`: to download video data -- `yt-dlp`: to stream the file the user requested +It's a svelte(kit) frontend that uses `yt-dlp` to let the user download things from the web. ### Getting started - Clone the repo - Run `npm install` (you have to have node installed) +- Run `npm run download-yt-dlp` +- Copy `.env.example` to `.env` +- Change `.env` to set `YTDLP_PATH` to the yt-dlp binary previously downloaded - Run `npm run dev` - Now you can write code ### Missing -- Proper logs -- Containerfile +- Proper logs (I don't like them, not useful for production build) +- Containerfile for container build - Source spotify (spotdl) - Parse URL info without `youtube-dl-exec` diff --git a/static/screen.webp b/static/screen.webp new file mode 100644 index 0000000..014e5f4 Binary files /dev/null and b/static/screen.webp differ