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

update README

Browse source
This commit is contained in:
ari melody 2026-01-31 04:19:20 +00:00
parent 51a1de845f
commit c52290392d
Signed by: ari
GPG key ID: CF99829C92678188
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -14,8 +14,13 @@ I built this to greatly simplify the process of getting my full-quality livestre
$ vodular $ vodular
New config file created (config.toml). Please edit this file before running again! 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. **IMPORTANT:** `config.toml` contains very sensitive credentials. Do not share this file with anyone.
3. Initialise a VOD directory: 3. Initialise a VOD directory:
@ -63,10 +68,11 @@ url = 'https://example.org'
``` ```
## Templates ## Templates
Template files can be created at `templates/title.txt`, There are three template files, `title.txt`, `description.txt`, and `tags.txt`,
`template/description.txt`, and `templates/tags.txt` respectively. These which can be created in `/path/to/vodular/templates`. These templates can be
files can use Go's [text template format](https://pkg.go.dev/text/template) to created and tweaked to customise your VOD metadata on upload. They are enhanced
customise VOD metadata on upload. 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: You can use the following data in templates:
- **`.Title`:** The title of the stream. - **`.Title`:** The title of the stream.