ari/vodular
1
0
Fork 0
Code Issues Releases 6 Activity Actions

update readme

Browse source
This commit is contained in:
ari melody 2026-06-23 19:08:08 +01:00
parent 234caa159e
commit f3419ebe22
Signed by: ari
GPG key ID: 60B5F0386E3DDB7E
1 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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`.