From d0de6acdd797c12af40bb79f69c3361c57ce8ee7 Mon Sep 17 00:00:00 2001 From: Reppard Date: Sun, 16 Feb 2020 16:44:03 -0800 Subject: storage-widget: initial implementation --- storage-widget/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 storage-widget/README.md (limited to 'storage-widget/README.md') diff --git a/storage-widget/README.md b/storage-widget/README.md new file mode 100644 index 0000000..48d2ffe --- /dev/null +++ b/storage-widget/README.md @@ -0,0 +1,24 @@ +# Storage 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` +with different mounts as arguments. + + +```lua + local storage_widget = require("awesome-wm-widgets.storage-widget.storage-widget") + ... + s.mywibox:setup { + s.mytasklist, -- Middle widget + { -- Right widgets + storage_widget(), --default + wibox.widget.textbox(':'), + storage_widget({ mounts = { '/', '/mnt/musicj' } }), -- multiple mounts + ... + +``` + +## Installation + +Please refer to the [installation](https://github.com/streetturtle/awesome-wm-widgets#installation) section of the repo. -- cgit v1.2.3