summaryrefslogtreecommitdiff
path: root/fs-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fs-widget/README.md')
-rw-r--r--fs-widget/README.md27
1 files changed, 16 insertions, 11 deletions
diff --git a/fs-widget/README.md b/fs-widget/README.md
index 5cda048..f134b05 100644
--- a/fs-widget/README.md
+++ b/fs-widget/README.md
@@ -1,10 +1,21 @@
# Filesystem Widget
-This widget shows disk usage. When clicked another widget appears with more detailed information. By default it monitors the "/" mount. It can be configured with a
-list of mounts to monitor though only the first will show in the wibar. To have
-multiple mounts displayed on the wibar simply define multiple `fs_widgets`
-with different mounts as arguments.
+This widget shows file system disk space usage which is based on the `df` output. When clicked another widget appears with more detailed information. By default it monitors the "/" mount. It can be configured with a list of mounts to monitor though only the first will show in the wibar. To have multiple mounts displayed on the wibar simply define multiple `fs_widgets` with different mounts as arguments.
+![](./screenshot.png)
+
+## Cusomizations
+
+It is possible to customize widget by providing a table with all or some of the following config parameters:
+
+| Name | Default | Description |
+|---|---|---|
+| `mounts` | `{'/'}` | Table with mounts to monitor, check the output from a `df` command for available options (column 'Mounted on') |
+| `timeout` | 60 | How often in seconds the widget refreshes |
+
+## Installation
+
+Clone/download repo and use the widget in **rc.lua**:
```lua
local fs_widget = require("awesome-wm-widgets.fs-widget.fs-widget")
@@ -13,12 +24,6 @@ with different mounts as arguments.
s.mytasklist, -- Middle widget
{ -- Right widgets
fs_widget(), --default
- wibox.widget.textbox(':'),
- fs_widget({ mounts = { '/', '/mnt/musicj' } }), -- multiple mounts
+ fs_widget({ mounts = { '/', '/mnt/music' } }), -- multiple mounts
...
-
```
-
-## Installation
-
-Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo.