summaryrefslogtreecommitdiff
path: root/apt-widget/README.md
diff options
context:
space:
mode:
authorstreetturtle <streetturtle@gmail.com>2021-05-05 22:16:08 -0400
committerstreetturtle <streetturtle@gmail.com>2021-05-05 22:16:08 -0400
commit892926936c8dbda0da94f14521c11d8f2687f44f (patch)
tree8717e47dcb4781575f7cb3e295f347406b2bb226 /apt-widget/README.md
parentfbd696d5f2ea9e4e43f9d89ecf874754c8c7db01 (diff)
[apt] new widget
Diffstat (limited to 'apt-widget/README.md')
-rw-r--r--apt-widget/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/apt-widget/README.md b/apt-widget/README.md
new file mode 100644
index 0000000..f3ac47a
--- /dev/null
+++ b/apt-widget/README.md
@@ -0,0 +1,27 @@
+# APT widget
+
+Widget which shows a list of APT packages to be updated:
+
+![screenshot](./screenshots/screenshot.gif)
+
+Features:
+ - scrollable list !!! (thanks to this [post](https://www.reddit.com/r/awesomewm/comments/isx89x/scrolling_a_layout_fixed_flexed_layout_widget/) of reddit)
+ - update single package
+ - update multiple packages
+
+## Installation
+
+Clone the repo under ~/.config/awesome/ folder, then in rc.lua add the following:
+
+```lua
+local apt_widget = require("awesome-wm-widgets.apt-widget.apt-widget")
+
+...
+s.mytasklist, -- Middle widget
+ { -- Right widgets
+ layout = wibox.layout.fixed.horizontal,
+ ...
+ apt_widget(),
+ ...
+```
+