From 4a9a4313f12063542ad2286ea037157f55c66503 Mon Sep 17 00:00:00 2001 From: Alex Mazanov Date: Tue, 9 Mar 2021 13:57:56 -0500 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1608b3c..aacf198 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Runs on macOS Catalina (10.15) and up. SwiftBar is bundled with a Plugin Repository. You can access it at Swiftbar → Get Plugins...

- A screenshot of SwiftBar’s Plugin Repository + A screenshot of SwiftBar’s Plugin Repository

If you want to add\remove plugin or have other questions about repository content please refer to this [issue](https://github.com/swiftbar/swiftbar-plugins/issues/1). @@ -183,7 +183,6 @@ SwiftBar adopts metadata format suggested by BitBar: # python,ruby,node # http://url-to-about.com/ # Supported UTI's for dropping things on menu bar - ``` #### Hiding default items @@ -208,6 +207,18 @@ A special tag can be used as an alternative to refresh interval defined in plugi 01,16,31,46 * * * * ``` +#### Other Parameters + +* `false` - doesn't wrap plugins in Bash when running +* `streamable` - mark plugin as Streamable +* `['var1':'default value', 'var2':'default value', ... ]` - this variables will be passed in plugin's environment, in later release SwiftBar will provide a UI to change values for these variables. + +#### Metadata for Binary Plugins + +For binary plugins metadata can be added as an extended file attribute: + +`xattr -w "com.ameba.SwiftBar" "$(cat metadata.txt | base64)" ` + ## URL Scheme | Endpoint | Parameter | Description | Example | | ------------- | ------------- |------------- | ------------- | @@ -217,7 +228,13 @@ A special tag can be used as an alternative to refresh interval defined in plugi | addplugin | `src` source URL to plugin file | Add plugin to Swiftbar from URL | `swiftbar://addplugin?src=https://coolplugin` | | notify | `plugin` plugin [name](#plugin-naming), notification fields `title`, `subtitle`, `body` and disable sound `silent=true` | Show notification | `swiftbar://notify?plugin=MyPlugin&title=title&subtitle=subtitle&body=body&silent=true` | +## Preferences aka 'defaults' +List of preferences that are not exposed in SwiftBar UI: +* `defaults write com.ameba.SwiftBar DisableBashWrapper -bool YES` - doesn't wrap plugins in Bash when running +* `defaults write com.ameba.SwiftBar MakePluginExecutable -bool NO` - disables auto `chmod +x` all files in Plugin Directory +* `defaults write com.ameba.SwiftBar PluginDeveloperMode -bool YES` - enables editing in Preferences -> Plugins +* `defaults write com.ameba.SwiftBar StreamablePluginDebugOutput -bool YES` - enables debug output for Stramable plugins, Swiftbar will expose the stream data in Console.App ## Logs and Error