Skip to content

Commit

Permalink
Tweak config docs to match reality
Browse files Browse the repository at this point in the history
  • Loading branch information
Evertras committed Jan 30, 2024
1 parent faeb3b5 commit 62bb6c8
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions docs/config.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Config

_NOTE: none of this is implemented and is subject to change.
_NOTE: none of this is finalized and is subject to change.
Just getting a feel for what it might look like._

Configuration can be provided in YAML, JSON, or TOML.
Configuration can be provided in YAML, JSON, TOML, HCL, INI.
Examples are in [the examples directory](../examples/).

## Layout

Expand All @@ -29,14 +30,10 @@ layout:
# Pane including children stacked top to bottom
- stack: vertical
children:
- name: Host metrics
module: host-metrics
- name: Disk free
module: command
config:
cpu:
memory:
unit: mb
disk:
unit: mb
bash: df -h
- name: Weather
module: graph
config:
Expand Down

0 comments on commit 62bb6c8

Please sign in to comment.