From cf088ce295c9af6e01147bc7e6ba74974ee60273 Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Mon, 19 Aug 2024 01:22:33 -0700 Subject: Update README.md to show usage --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4ea85fb..eaf0a11 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # YouTube Auto Stamp -A Curses CLI Python program that auto generates timestamps for ongoing YouTube livestreams based on message rate \ No newline at end of file +A CLI program that tracks the speed of a YouTube live chat and records down moments of high chat activity. It can also count income via Superchats + find keywords in chat as a side task. + +``` +YouTube Live Chat Message Rate Tracker + +positional arguments: + video_id The ID of the YouTube video for the live chat + +options: + -h, --help show this help message and exit + --show-chat Show the live chat in the terminal window + --superchats Log superchat messages and amounts + --threshold THRESHOLD + Log timestamps when the message rate exceeds this value (msg/s) + --keywords KEYWORDS Log timestamps when a message contains any of these keywords. Enter keywords separated by commas + --cooldown COOLDOWN Minimum time that must pass before another notable moment is logged (in seconds) + +Example: +python yt_livechat_stats.py OoNndQzHMlI --show-chat --superchats --threshold 15 --cooldown 30 +``` -- cgit v1.2.3