From f3419ebe22142a485bb99f9cfdc31f4bd3f031a2 Mon Sep 17 00:00:00 2001 From: ari melody Date: Tue, 23 Jun 2026 19:08:08 +0100 Subject: [PATCH] update readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff53e8f..25360ea 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Vodular -This tool stitches together livestream VOD segments (in `.mkv`format) and automatically uploads them to YouTube, complete with customisable metadata such as titles, descriptions, and tags. +This tool stitches together livestream VOD segments (in `.mkv`format) and automatically uploads them to YouTube, complete with customisable metadata such as titles, descriptions, tags, and a thumbnail! I built this to greatly simplify the process of getting my full-quality livestream VODs onto YouTube, and I'm open-sourcing it in the hopes that it helps someone else with their workflow. As such, personal forks are welcome and encouraged! @@ -29,11 +29,17 @@ $ vodular --init /path/to/vod Directory successfully initialised. Be sure to update metadata.toml before uploading! ``` +This directory should contain: +- A `metadata.toml` file +- Your footage files, either at the root of the directory or in a specified subdirectory +- Your thumbnail, specifically named `thumbnail.png` + 4. Modify your newly-created `metadata.toml` to your liking. -5. Upload a VOD (Optionally, delete the redundant full VOD export afterwards): +5. Upload a VOD! ```sh -$ vodular --deleteAfter /path/to/vod +# `--deleteAfter` deletes the redundant full VOD export afterwards +vodular --deleteAfter /path/to/vod ``` **NOTE:** On first run, you will be prompted to sign in to YouTube with the channel you wish to upload to. To sign out, simply run `vodular --logout`.