updated README
This commit is contained in:
parent
5605a9fceb
commit
e27d218d2e
1 changed files with 22 additions and 1 deletions
23
README.md
23
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
|
||||
|
||||
|
|
Loading…
Reference in a new issue