ID

13b0b3d

date

2025-10-05 07:06:30+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

96e65c9

message

README: add a bit more info

changed files

1 file, 7 additions

• README.md

Changed files

README.md (1365) → README.md (1681)

diff --git a/README.md b/README.md
index e91e254..410872e 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,10 @@ $ yt-dlp_alexwlchan.py "https://www.youtube.com/watch?v=TUQaGhPdlxs"
 
 I have other scripts that know how to read this format, and it allows me to consolidate all my YouTube-handling logic in one place.
 Other scripts can call this script and get the title or description "for free".
+
+## What it does
+
+*   Downloads the video, thumbnail, and subtitles to a temporary directory
+*   Convert the video to MP4 and the thumbnail to JPEG (my preferred formats)
+*   Gets some info about the video (title, description) and channel (name, URL, avatar URL)
+*   Prints all that info in a convenient JSON object