From 7204835592b53f5c11870461e5884b909108eb59 Mon Sep 17 00:00:00 2001
From: emma <emma@tebibyte.media>
Date: Thu, 2 Nov 2023 22:50:00 -0600
Subject: [PATCH] added README

---
 README | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..bc04b4e
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+yt(1) is a helper script providing functions for use with mpv and yt-dlp for
+viewing and interacting with YouTube videos.
+
+Dependencies:
+- curl(1)
+- fzf(1)
+- jq(1)
+- mpv(1)
+- yt-dlp(1)
+
+Usage:
+yt add | clone | music | pick | play | verify
+
+add uri file
+- Adds a video by URI to a playlist
+
+cache uri...
+- Caches a video title
+
+clone uri file
+- Clones a YouTube playlist to a file
+
+music uri...
+- Downloads a video as audio, splitting it by chapter
+
+pick file...
+- Opens fzf(1) to a list of videos in a file
+
+play uri...
+- Plays a video, caching its title first
+
+verify file...
+- Verifies that all the videos in a playlist are existent on YouTube, and if
+they aren’t, attempts to replace the URI with one from the Wayback Machine. If
+the video isn’t available on the Wayback Machine, it comments the video link. It
+then caches the title of the video.