Skip to content

Add example for properties & Add helper string #519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 9, 2025
Merged

Add example for properties & Add helper string #519

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6c6575
Update README.md
Jack251970 Jun 8, 2025
300384d
Update IcoPath example
Jack251970 Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ Looking for a list of currently available plugins in Flow? Visit [here](https://
4. It should look like this:
```json
{
"ID": "Unique GUID from your plugin.json",
"Name": "Plugin name",
"Description": "Short description",
"Author": "Author",
"Version": "Version from your plugin.json",
"Language": "Programming language",
"Website": "Plugin website",
"UrlDownload": "URL to download",
"UrlSourceCode": "URL to source code",
"IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher/Plugins/Flow.Launcher.Plugin.Explorer/Images/explorer.png"
"ID": "Unique GUID from your plugin.json, e.g. 2f4e384e-76ce-45c3-aea2-b16f5e5c328f",
"Name": "Plugin name, e.g. Hello World Python",
"Description": "Short description, e.g. Python Hello World example plugin",
"Author": "Author, e.g. Flow Launcher",
"Version": "Version from your plugin.json, e.g. 1.0.0",
"Language": "Programming language, e.g. python",
"Website": "Plugin website, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython",
"UrlDownload": "URL to download, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/releases/download/v1.0.0/Flow.Launcher.Plugin.HelloWorldPython.zip",
"UrlSourceCode": "URL to source code, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/tree/main",
"IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython@main/Images/app.png"
}
```
5. For `IcoPath`, use a CDN provider for global accessibility. [jsdelivr.com](https://www.jsdelivr.com/) for example as shown above, works well with GitHub repositories.
Expand All @@ -49,6 +49,8 @@ While the plugin has not yet appeared in the store, you and your users can manua

Every three hours the *CI* in this repository will check for new updates from plugins and automatically update them to the latest version.

So you do not need to manually submit a pull request after you make a new release.

## Plugin Store policy

Plugins that facilitate or contain any of the following will not be allowed:
Expand Down