From ababeaacf820a88af6c253083e7c760257e32dbc Mon Sep 17 00:00:00 2001 From: Evan Fiordeliso Date: Sat, 15 Apr 2023 17:32:44 -0400 Subject: [PATCH] Update README file --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dede5c1..872c2f6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,41 @@ # YTDL Web +## Usage + +```sh +ytdl-web [OPTIONS] +``` + +Available options: + +- -b, --base-path string the base path, used when behind reverse proxy (default is "") +- --config string config file (default is $XDG_CONFIG_HOME/ytdl-web/config.yml) +- -h, --help help for ytdl-web +- -l, --listen string address to listen on (default is 127.0.0.1) (default "127.0.0.1") +- -p, --port int port to listen on (default is 8080) (default 8080) +- -y, --ytdlp-path string the path to the yt-dlp binary, used when it is not in $PATH (default is yt-dlp) (default "yt-dlp") + +## Building from source + +Prerequisites: + +- [go v1.20](https://go.dev/doc/install) +- [task cli](https://taskfile.dev/installation/) + +Steps: + +1. Download dependencies + +```sh +task deps +``` + +2. Build binary + +```sh +task build +``` + ## Publishing Docker Image Prerequsites: @@ -34,7 +70,7 @@ Steps: 1. Add the helm repo ```sh -helm repo add --username {username} --password {password} gitea-apps https://gitea.example.com/api/packages/apps/helm +helm repo add --username {username} --password {password} gitea-apps https://git.fifitido.net/api/packages/apps/helm ``` 2. Publish the chart