From 9d3a0a1e7e9006bd33c8002a6fbda26921b63f90 Mon Sep 17 00:00:00 2001 From: Flisk <73703417+Flisk@users.noreply.github.com> Date: Tue, 15 Nov 2022 18:47:55 +0100 Subject: [PATCH] Edit and amend URL scheme documentation There's two changes here: First, I moved the "disclaimers" section up between the URL scheme table and the headline to make it harder to miss. Second, I added a hint to use `-g` with `open`, because the problem described in issue 268 bit me as well, and just like @shepazon, I wasn't really aware what the problem was, nor that `-g` would fix it. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e050f3b..1fae635 100644 --- a/README.md +++ b/README.md @@ -270,6 +270,12 @@ echo "Test 2" You can mark a plugin as streamable with a special metadata property `streamable` ## URL Scheme + +Some notes: + +* Instead of the plugin [name](#plugin-naming), you can (and probably should) use the plugin file name. This considered a unique plugin ID, whereas `name` can be the same between multiple plugins. If your plugin's filepath is `~/Documents/SwiftBar/myplugin.1m.sh`, then the name is `myplugin` and the ID `myplugin.1m.sh` +* When using `open(1)` to trigger scheme URLs, use `-g` to prevent the command from stealing focus from your active app. + | Endpoint | Parameter | Description | Example | | ------------- | ------------- |------------- | ------------- | | refreshallplugins | none | Force refresh all loaded plugins | `swiftbar://refreshallplugins` | @@ -281,8 +287,6 @@ You can mark a plugin as streamable with a special metadata property `