mirror of
https://codeberg.org/frosty/modbot.git
synced 2024-09-19 11:46:34 -04:00
remove example config, and add some info
This commit is contained in:
parent
0f9c827bb2
commit
633a3a7e6b
42
README.md
42
README.md
|
@ -19,42 +19,8 @@ Usage of modbot:
|
||||||
-x set x root window name
|
-x set x root window name
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example
|
## Information
|
||||||
|
|
||||||
### Configuration
|
* If an empty string is returned from a module, then the corresponding module will not be displayed.
|
||||||
|
* If a module returns a non-`nil` value for its error, or if the exit code of an exec module is non-zero, then `failed` will be shown for the corresponding module.
|
||||||
```go
|
* Modules can be updated on an interval, signal, or both.
|
||||||
var (
|
|
||||||
delim = []byte("] [")
|
|
||||||
prefix = []byte("[")
|
|
||||||
suffix = []byte("]")
|
|
||||||
)
|
|
||||||
|
|
||||||
var modules = []Module{
|
|
||||||
{
|
|
||||||
Func: readers.ReadCpuUsage(),
|
|
||||||
Interval: 5 * time.Second,
|
|
||||||
Template: `CPU {{printf "%.0f" .UsagePercent}}%`,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Func: readers.ReadBattery("BAT1"),
|
|
||||||
Interval: 60 * time.Second,
|
|
||||||
Template: "BAT {{.Capacity}}%",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Func: readers.ReadDate("15:04:05"),
|
|
||||||
Interval: 1 * time.Second,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
Func: readers.ReadLoad(),
|
|
||||||
Interval: 5 * time.Second,
|
|
||||||
Template: "{{.OneMinute}}",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Output
|
|
||||||
|
|
||||||
```
|
|
||||||
[CPU 8%] [BAT 100%] [03:15:57] [0.62]
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in a new issue