summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorbtkoch <brandon@brandon-desktop.localdomain>2023-11-25 18:28:00 -0500
committerbtkoch <brandon@brandon-desktop.localdomain>2023-11-25 18:28:00 -0500
commit6d4bc9cceb9a180acb811d409745ce5dd3732e1d (patch)
tree2f67362225adb960fc4aef2e822533bdbf61d26a /README.md
parentd6e4c4e9ad72d71cf01f835e03ffed100d69fccd (diff)
Complete rewrite and rename
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 29 insertions, 2 deletions
diff --git a/README.md b/README.md
index 804b3ec..36e1e39 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# yt-feed
-Simple bash script that takes a YouTube channel name as input and outputs either the RSS feed URL or, with the `-i` option, the channel ID.
+# ytuh
+## (YouTube URL Helper)
+
+A bash script designed to help with handling YouTube URLs
+
+## Usage
+By default, the script takes YouTube channel name (without the @) as input and returns the channel ID.
+
+```
+$ ytuh jawed
+UC4QobU6STFB0P71PMvOGN5A
+```
+
+The `-r` (reverse) option reverses this behavior: the user inputs a channel ID and the script prints the corresponding channel name.
+
+```
+$ ytuh UC4QobU6STFB0P71PMvOGN5A
+jawed
+```
+
+The `-f` (feed) option will cause the script to output the RSS feed for the channel provided.
+
+```
+$ ytuh -f jawed
+https://youtube.com/feeds/videos.xml?channel_id=UC4QobU6STFB0P71PMvOGN5A
+```
+
+It should be noted that `-rf` does work as expected, retrieving a feed URL from a channel ID.
+While this may seem useless, and it probably is, I saw no reason why I shouldn't make it work on the off-chance that it might improve someone's workflow, somehow.