summaryrefslogtreecommitdiff
path: root/fs-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@users.noreply.github.com>2020-11-01 14:32:33 -0500
committerGitHub <noreply@github.com>2020-11-01 14:32:33 -0500
commitef9292d082d74ac09cfc3e874ef8c933be9e0651 (patch)
tree57343fc0112b359c69727250c86997edb4de262a /fs-widget/README.md
parent0daa2ca83d9bd8c225ce0ec709531765e79308f6 (diff)
parent1c19fff4be8d41c8e3b241e2e7b1a046cc5c39d8 (diff)
Merge pull request #204 from floli/fix-fswidget-readme
Fix fs-widget README.
Diffstat (limited to 'fs-widget/README.md')
-rw-r--r--fs-widget/README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/fs-widget/README.md b/fs-widget/README.md
index 48d2ffe..5cda048 100644
--- a/fs-widget/README.md
+++ b/fs-widget/README.md
@@ -1,20 +1,20 @@
-# Storage Widget
+# 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 `storage_widgets`
+multiple mounts displayed on the wibar simply define multiple `fs_widgets`
with different mounts as arguments.
```lua
- local storage_widget = require("awesome-wm-widgets.storage-widget.storage-widget")
+ local fs_widget = require("awesome-wm-widgets.fs-widget.fs-widget")
...
s.mywibox:setup {
s.mytasklist, -- Middle widget
{ -- Right widgets
- storage_widget(), --default
+ fs_widget(), --default
wibox.widget.textbox(':'),
- storage_widget({ mounts = { '/', '/mnt/musicj' } }), -- multiple mounts
+ fs_widget({ mounts = { '/', '/mnt/musicj' } }), -- multiple mounts
...
```