diff options
| author | Nuno Silva <nuno.m.ribeiro.silva@tecnico.ulisboa.pt> | 2021-04-11 19:40:51 +0100 |
|---|---|---|
| committer | Nuno Silva <nuno.m.ribeiro.silva@tecnico.ulisboa.pt> | 2021-04-11 19:40:51 +0100 |
| commit | 94f9aef1c59fd5cee1b30cc5afac2808f3295e32 (patch) | |
| tree | d87982e1586036e95caf7bca8136e504b6b4086e /ram-widget | |
| parent | 42dd36c6040f8ca7a6103a653c02224a7df85647 (diff) | |
ram-widget: document arguments
Diffstat (limited to 'ram-widget')
| -rw-r--r-- | ram-widget/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/ram-widget/README.md b/ram-widget/README.md index 461aa99..8f8eee4 100644 --- a/ram-widget/README.md +++ b/ram-widget/README.md @@ -4,6 +4,18 @@ This widget shows the RAM usage. When clicked another widget appears with more d  +## Customization + +It is possible to customize widget by providing a table with all or some of the following config parameters: + +| Name | Default | Description | +|---|---|---| +| `color_used` | `beautiful.bg_urgent` | Color for used RAM | +| `color_free` | `beautiful.fg_normal` | Color for free RAM | +| `color_buf` | `beautiful.border_color_active` | Color for buffers/cache | +| `widget_show_buf` | `false` | Whether to display buffers/cache separately in the tray widget. If `false`, buffers/cache are considered free RAM. | +| `timeout` | 1 | How often (in seconds) the widget refreshes | + ## Installation Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo.
\ No newline at end of file |