aboutsummaryrefslogtreecommitdiff
path: root/scripts/ytdlp_channel_info.md
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/ytdlp_channel_info.md')
-rw-r--r--scripts/ytdlp_channel_info.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/scripts/ytdlp_channel_info.md b/scripts/ytdlp_channel_info.md
index e69de29..b824317 100644
--- a/scripts/ytdlp_channel_info.md
+++ b/scripts/ytdlp_channel_info.md
@@ -0,0 +1,16 @@
+# yt-dlp Channel Info Generator
+
+Saves channel metadata for yt-dlp channels or playlists.
+
+Currently supported task kinds are: `youtube-channel-info` and
+`bilibili-channel-info`.
+
+It will place files in the `output` directory of the task:
+
+- `channel.info.json`: A yt-dlp info.json for the channel
+- `backdrop.jpeg`: The channel's banner picture
+- `poster.jpeg`: The channel icon
+
+## Configuration
+
+None