Mention execution time for RunCommand

daenney · Mar 14, 2024 · 8e3429f · 8e3429f
1 parent 737e5cb
commit 8e3429f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,6 +24,8 @@ These are the functions you can call from your scripts:
 | PlayPause[^1]  | player name | `PlayPause("spotify")` | Toggle music play/pause |
 | RunCommand | command     | `RunCommand("notify-send", "title", "body")` | Execute arbitrary command |
 
+`RunCommand` is constrained to run up to 1s, after which the context will be cancelled. This ensures we don't have hanging commands.
+
 [^1]: `PlayPause` uses the D-Bus user session and as such only works on Linux
 
 ## Running