From 892926936c8dbda0da94f14521c11d8f2687f44f Mon Sep 17 00:00:00 2001
From: streetturtle <streetturtle@gmail.com>
Date: Wed, 5 May 2021 22:16:08 -0400
Subject: [apt] new widget

---
 apt-widget/README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 apt-widget/README.md

(limited to 'apt-widget/README.md')

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(),
+		...
+```
+
-- 
cgit v1.2.3