summaryrefslogtreecommitdiff
path: root/storage-widget/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'storage-widget/README.md')
-rw-r--r--storage-widget/README.md24
1 files changed, 0 insertions, 24 deletions
diff --git a/storage-widget/README.md b/storage-widget/README.md
deleted file mode 100644
index 48d2ffe..0000000
--- a/storage-widget/README.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# 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.