Hesham/yttopodcast
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: add more command doc

Browse Source 
Signed-off-by: HeshamTB <hishaminv@gmail.com>
This commit is contained in:
HeshamTB 2024-08-09 16:53:35 +03:00
parent 5893b27e60
commit f85c7cf3ac
Signed by: Hesham
GPG Key ID: 74876157D199B09E
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -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 fetch valid links from yt. Since getting the content URLs is quite slow, the implemented bouncer
has a basic cache. 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 ## genfeed
Generate a feed given a channel id Generate a feed given a channel id
```sh ```sh
@ -14,9 +26,10 @@ cd cmd/genfeed
go build . go build .
./genfeed -id CHANNEL_ID > feed.xml ./genfeed -id CHANNEL_ID > feed.xml
``` ```
`feed.xml` file can be used as an RSS feed.
## ytbouncer ## 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 ```sh
cd cmd/ytbouncer cd cmd/ytbouncer
go build . go build .