From be1365a0d057fe0565e000cb27d2c363c3818d0b Mon Sep 17 00:00:00 2001
From: Kevin Lyda <kevin@lyda.ie>
Date: Sun, 27 Nov 2022 18:06:06 +0000
Subject: [PATCH] Add a better description of tasks.

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index 4726817..e20ed6a 100644
--- a/README.md
+++ b/README.md
@@ -22,3 +22,37 @@ To show/hide: `i3-msg 'bar mode toggle bottom'`
 To restart: `i3-msg restart`
 
 [i3bar]: https://i3wm.org/docs/i3bar-protocol.html
+
+## Goals
+
+  * Modules
+    * Disks
+      * Show disk usage for all partitions for a given fstype.
+      * Send alerts for low disk space.
+    * Battery
+      * Run this when the battery is low:
+        `notify-send -a battery -i /usr/share/icons/Humanity/status/16/battery-caution.svg "Low Battery" "Battery is low.  Please plug in."`
+    * Network
+      * Show IP address
+      * For wifi show ESSID or strength
+    * Volume setting for mic and speaker (two different modules)
+      * Clicks - left down, right up, middle toggle mute
+    * Date
+      * Go format for time
+      * Click opens calendar
+    * Script
+      * Emits json output that fits the standard.
+  * Conditionals: Only show some modules if a condition is met.
+  * Clicks
+    * Should be able to set things to run for each modifier:button.  Either (or both) can be set to ALL to match anything.
+    * Set environment vars with all the context:
+      * `I3GO_NAME="color"`
+      * `I3GO_BUTTON=1`
+      * `I3GO_MODIFIERS="control:shift"`
+      * `I3GO_X=1902`
+      * `I3GO_Y=1143`
+      * `I3GO_RELATIVE_X=9`
+      * `I3GO_RELATIVE_Y=13`
+      * `I3GO_WIDTH=24`
+      * `I3GO_HEIGHT=22`
+
-- 
GitLab