diff --git a/README.md b/README.md index 3aacb9a..780db95 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,111 @@ -# automated-youtube-dl - -_Automated YouTube Archival._ - -A wrapper for youtube-dl used for keeping very large amounts of data from YouTube in sync. It's designed to be simple and easy to use. - -I have a single, very large playlist that I add any videos I like to. This runs as a service on my NAS (see [Example systemd Service.md]). - -### Features - -- Uses yt-dlp instead of youtube-dl. -- Skips videos that are already downloaded. -- Automatically update yt-dlp on launch. -- Download the videos in a format suitable for archiving: - - Complex `format` that balances video quality and file size. - - Embedding of metadata: chapters, thumbnail, english subtitles (automatic too), and YouTube metadata. -- Log progress to a file. -- Simple display using `tqdm`. -- Limit the size of the downloaded videos. -- Parallel downloads. -- Daemon mode for running as a system service. - -### Installation - -```bash -sudo apt update && sudo apt install ffmpeg atomicparsley phantomjs -pip install -r requirements.txt -``` - -### Usage - -This program has 3 modes: - -
- -**Direct-Download Mode:** - -In this mode, you give the downloader a URL to the media you want to download. - -`./downloader.py