aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2024-08-19 01:22:33 -0700
committerGitHub <noreply@github.com>2024-08-19 01:22:33 -0700
commitcf088ce295c9af6e01147bc7e6ba74974ee60273 (patch)
treeb18bd52a8883f3d7d3fc132117e390b958a505d5 /README.md
parent52b41b548c9ba14d9d1a145cc7ace1bcb5cc5bc8 (diff)
Update README.md to show usageHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
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
+```
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage