summaryrefslogtreecommitdiff
path: root/ram-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2021-04-11 20:36:09 -0400
committerGitHub <noreply@github.com>2021-04-11 20:36:09 -0400
commit83856a188b43b0ef908c360310c069d27864c134 (patch)
tree8b077cbf443a5b29b65bbfdc7019a3f25f7221b9 /ram-widget/README.md
parentaaa6fa2aaa6abce718db3170cd3a6db6d45d60e5 (diff)
parent94f9aef1c59fd5cee1b30cc5afac2808f3295e32 (diff)
Merge pull request #249 from nuno-silva/ram-colors
ram-widget: support custom colors and document arguments
Diffstat (limited to 'ram-widget/README.md')
-rw-r--r--ram-widget/README.md12
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
![screenshot](./out.gif)
+## 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