Add dependency and usage info

[rbdr/r.bdr.sh] / swiftbar_scripts.gmi

diff --git a/swiftbar_scripts.gmi b/swiftbar_scripts.gmi
index dc6c80ef521df173a8195620824b0291381ac179..8344cd5c0ac9e38e23cbdfc5798feaf6d2cf37bf 100644 (file)
--- a/swiftbar_scripts.gmi
+++ b/swiftbar_scripts.gmi
@@ -10,8 +10,16 @@ one, I'm not sure whether they work with xbar[2], but should probably be OK.
 
 View the status of your last few builds in sourcehut. You can open the URL by clicking on the menu items. The count of failed, pending and successful runs of the last 15m are shown next to the icon.
 
 
 View the status of your last few builds in sourcehut. You can open the URL by clicking on the menu items. The count of failed, pending and successful runs of the last 15m are shown next to the icon.
 

+### Dependencies
+
+You must have jq and curl installed.
+
+### Usage
+

 To use the plugin you'll need to set your sourcehut token in the VAR_SOURCEHUT_API_TOKEN variable (See the 'ADD YOUR TOKEN HERE' string). You can also control how many builds to show by changing the VAR_BUILD_COUNT variable (defaults to 5)
 
 To use the plugin you'll need to set your sourcehut token in the VAR_SOURCEHUT_API_TOKEN variable (See the 'ADD YOUR TOKEN HERE' string). You can also control how many builds to show by changing the VAR_BUILD_COUNT variable (defaults to 5)
 

+### Focus Checks
+

 This script includes focus checks (See focus checks column at the end of this page on how to use them.)
 
 => ./swiftbar/sourcehut-builds.1m.sh ⧇ source
 This script includes focus checks (See focus checks column at the end of this page on how to use them.)
 
 => ./swiftbar/sourcehut-builds.1m.sh ⧇ source


@@ -20,6 +28,16 @@ This script includes focus checks (See focus checks column at the end of this pa
 
 View your monitorcito[3] tracked services at a glance. ○ is shown if everything is OK, and ╳ if at least one service is failing. Clicking on an item refreshes the status.
 
 
 View your monitorcito[3] tracked services at a glance. ○ is shown if everything is OK, and ╳ if at least one service is failing. Clicking on an item refreshes the status.
 

+### Dependencies
+
+You must have jq and curl installed.
+
+### Usage
+
+You can control the URL of the monitorcito instance by adjusting VAR_MONITORCITO_URL
+
+### Focus Checks
+

 This script includes focus checks (See focus checks column at the end of this page on how to use them.)
 
 => https://git.sr.ht/~rbdr/monitorcito [3] Monitorcito
 This script includes focus checks (See focus checks column at the end of this page on how to use them.)
 
 => https://git.sr.ht/~rbdr/monitorcito [3] Monitorcito


@@ -27,9 +45,15 @@ This script includes focus checks (See focus checks column at the end of this pa
 
 ## Focus Checks
 
 
 ## Focus Checks
 

+This is a utility that allows other scripts to conditionally run or halt based on which focus mode is enabled.
+
+### Dependencies
+
+You must have jq installed .
+

 ### Usage
 
 ### Usage
 

-You can ask a script to only continue if it matches a focus mode, or to halt if it encounters it. You can do this by passing pipe separated strings to VAR_RUN_ON_FOCUS or VAR_HALT_ON_FOCUS. For example, this will only run the script if "Personal" or "Do Not Disturb" are active:
+To enable the focus checks, you need to pass separated strings to VAR_RUN_ON_FOCUS or VAR_HALT_ON_FOCUS. For example, this will only run the script if "Personal" or "Do Not Disturb" are active:

 
 ```
 VAR_RUN_ON_FOCUS="Personal|Do Not Disturb"
 
 ```
 VAR_RUN_ON_FOCUS="Personal|Do Not Disturb"


@@ -43,6 +67,9 @@ VAR_HALT_ON_FOCUS="Work"
 
 If neither variable is set, then all checks will be disabled.
 
 
 If neither variable is set, then all checks will be disabled.
 

+The script will only appear or disappear when it's next refreshed. If you
+want this faster, trigger a full refresh of your plugins.
+

 ### Setup
 
 Download and copy focus.utils.sh to your SwiftBar directory on the same directory as the scripts that use this functionality.
 ### Setup
 
 Download and copy focus.utils.sh to your SwiftBar directory on the same directory as the scripts that use this functionality.