From e27d218d2ef673caa6395c1070d3240611cd0c7f Mon Sep 17 00:00:00 2001 From: Valerie Date: Wed, 9 Aug 2023 10:53:14 -0400 Subject: [PATCH] updated README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17a656e..3698ca1 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,30 @@ oink full ``` +## Configuration + +Variables are split into two sections for ease-of-use: `vars` and `colors`. + +Targets need two fields, `name` and `path`, containing a unique name and their +destination file respectively. They should go into the `target` array. + +```toml + +[vars] +name = "Test User" + +[colors] +example = "1A1A1A" + +[[target]] +name = "oink" +path = "/home/test/.config/oink/oink.toml" + +``` + ## Libraries - [pico-args](https://crates.io/crates/pico-args) — argument parsing -- [tera](https://crates.io/crates/tera) — template replacement +- [tera](https://crates.io/crates/tera) — template engine - [toml](https://crates.io/crates/toml) — configuration parsing