summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..71d0360
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+`invidious-dl.sh` - POSIX sh script to download YouTube videos using Invidious
+API. Distributes requests randomly between instances.
+
+# Examples
+```sh
+# list formats
+$ invidious-dl.sh -l -u 'https://yewtu.be/watch?v=2l6JUNFAJ9o'
+# download
+$ invidious-dl.sh -f 248+251 -u 'https://www.youtube.com/watch?v=2l6JUNFAJ9o'
+# list videos in playlist
+$ invidious-dl.sh -l -u 'https://yewtu.be/playlist?list=PLBBYHfkh_tzZpRxqt6SBMI5JZWd88qcIp'
+# print title of the video
+$ invidious-dl.sh -t -u 'https://yewtu.be/watch?v=aGip64cYJTg'
+Tom MacDonald - "Dear Rappers"
+```
+# Dependencies
+* [jq](https://stedolan.github.io/jq)
+* [curl](https://curl.se)
+* [ffmpeg](https://ffmpeg.org)