From f85c7cf3ac47163c17b6547a2eb640716afee1bf Mon Sep 17 00:00:00 2001 From: HeshamTB Date: Fri, 9 Aug 2024 16:53:35 +0300 Subject: [PATCH] README: add more command doc Signed-off-by: HeshamTB --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f0ae7a..ddabd35 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,18 @@ A web server is required to serve the RSS feed as a file, and an HTTP boucner se fetch valid links from yt. Since getting the content URLs is quite slow, the implemented bouncer has a basic cache. +# Usage +The tools can be used standalone, imported and invoked in go code, or run with the helpers as a collection. + +## yttopodcast +Generates single or multiple feeds on an interval, serves the feed files (RSS/XML), and launches a yt +link bouncer. This can be used as a complete service. +```sh +cd cmd/yttopodcast +go build . +./yttopodcast -id CHANNEL_ID +``` + ## genfeed Generate a feed given a channel id ```sh @@ -14,9 +26,10 @@ cd cmd/genfeed go build . ./genfeed -id CHANNEL_ID > feed.xml ``` +`feed.xml` file can be used as an RSS feed. ## ytbouncer -The bouncer uses standard go http and can be embedded +The bouncer uses standard go http and can be embedded. To run it standalone ```sh cd cmd/ytbouncer go build .