diff --git a/README.md b/README.md index 2b933a5..0209196 100644 --- a/README.md +++ b/README.md @@ -1 +1,81 @@ -❯ : PATH=~/go/bin:$PATH go generate ./... +Front end for youtube-dl +------------------------ + +Bare minimum zero dependency¹ single binary web app to download youtube videos using youtube-dl. Allows multiple downloads in parallel. Shows title and live download progress. Pull requests welcome. For a more feature full nicer looking app, checkout [YoutubeDL-Material](https://github.com/Tzahi12345/YoutubeDL-Material) + +¹ Uses `golang.org/x/net` for websockets. It is strictly not part of go standard library. + +Usage +----- + + ❯ go install gitlab.com/balki/ytui@latest + go: downloading gitlab.com/balki/ytui v0.0.0-... + + + ❯ ~/go/bin/ytui -h + 2022/06/30 10:53:46 Youtube UI + Usage of /home/balki/go/bin/ytui: + -cachepath string + Path where temporary download files are saved (default "./cache") + -dbpath string + Path where downloaded info is saved (default "./db.json") + -port int + Port to listen on (default 8080) + -videospath string + Path where videos are saved (default "./vids") + -videosurl string + Prefix of the url, i.e. https://domain.com//