From c52290392dc040bf25030fc0638476f3b3a4b4a4 Mon Sep 17 00:00:00 2001 From: ari melody Date: Sat, 31 Jan 2026 04:19:20 +0000 Subject: [PATCH] update README --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b36d3c7..ff53e8f 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,13 @@ I built this to greatly simplify the process of getting my full-quality livestre $ vodular New config file created (config.toml). Please edit this file before running again! ``` +The directory which holds your configuration file and templates varies, +depending on platform: +- **Linux:** `~/.config/vodular/templates` +- **macOS:** `~/Library/Application Support/vodular/templates` +- **Windows:** `%AppData%/vodular/templates` -2. Edit configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here). +2. Edit your configuration file as necessary (You will need to create a [YouTube Data API v3](https://developers.google.com/youtube/v3) service and provide its credentials here). **IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone. 3. Initialise a VOD directory: @@ -63,10 +68,11 @@ url = 'https://example.org' ``` ## Templates -Template files can be created at `templates/title.txt`, -`template/description.txt`, and `templates/tags.txt` respectively. These -files can use Go's [text template format](https://pkg.go.dev/text/template) to -customise VOD metadata on upload. +There are three template files, `title.txt`, `description.txt`, and `tags.txt`, +which can be created in `/path/to/vodular/templates`. These templates can be +created and tweaked to customise your VOD metadata on upload. They are enhanced +with Go's [template format](https://pkg.go.dev/text/template) to inject +information provided in `metadata.toml`, and other neat functionality! You can use the following data in templates: - **`.Title`:** The title of the stream.