update README

This commit is contained in:
Balakrishnan Balasubramanian 2022-07-27 23:14:12 -04:00
parent 231fc7a425
commit 9624a7f1bf

View File

@ -1,10 +1,11 @@
Front end for youtube-dl
------------------------
YTUI - 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.
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, but still from official go.
²Uses bootstrap for front-end. Files are embedded in the binary, does not make external requests both in front-end and back-end. See CSP header in [templates/index.html](templates/index.html#L6)
Install
-------
@ -12,13 +13,12 @@ Install
go install gitlab.com/balki/ytui@latest
go: downloading gitlab.com/balki/ytui v0.0.0-...
If you don't have and don't want to install go toolchain but have docker, below command gets the binary
If you don't have and don't want to install go tool-chain, use docker to get the binary
docker run --rm -v "${PWD}:/op" golang:latest sh -c "go install gitlab.com/balki/ytui@latest && cp -v /go/bin/ytui /op/"
go: downloading gitlab.com/balki/ytui v0.0.0-...
go: downloading golang.org/x/net v0.0.0-...
'/go/bin/ytui' -> '/op/ytui'
docker rmi golang:latest
Usage
-----