Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Welcome

If you have just started using Flow, this documentation should help familiarise you with how to get to the settings to customise Flow to your liking, show you some usage tips to use Flow more effectively, as well as provide more detailed documentation for plugin authors.
If you have just started using Flow, this documentation should get you started and help familiarise you with settings and customisation.

Start with the [**Quick Start**](/quickstart.md) guide for your first steps, and the dive into more detail from there. Any issues, check out the [**Support**](/support.md) page to see where you can go to get help. Browse the many community-created [**Plugins**](/plugins.md) to extend Flow to do just about anything.

And if you find a use case not covered, and are feeling creative, learn about [**Plugin Development**](/plugin-dev.md) and create your own!

Flow Launcher is created and maintained as an open source project by a worldwide team of productivity-passionate volunteers. We hope you enjoy using it as much as we enjoy creating it.
5 changes: 4 additions & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
- [**Introduction**](/README.md)
- [**Installation**](/installation.md)
- [**Quick Start**](/quickstart.md)
- [**Keyboard Shortcuts**](/keyboard-shortcuts.md)
- [**Settings**](/settings.md)
- [**File Manager**](/filemanager.md)
- [**Usage Tips**](/usage-tips.md)
- [**Support**](/support.md)
- [**Frequently Asked Questions**](/faq.md)
Comment thread
deefrawley marked this conversation as resolved.
- [**Plugin Store**](https://www.flowlauncher.com/plugins/)
- [**Explorer Plugin**](/plugin-explorer.md)
- [**Bookmark Plugin**](/plugin-bookmark.md)
- [**Plugin Development**](/plugin-dev.md)
- [**plugin.json**](/plugin.json.md)
- Dotnet Plugins
- .NET Plugins
- [**Development Guide**](/develop-dotnet-plugins.md)
- [**API Reference**](/API-Reference/Flow.Launcher.Plugin.md)
- Python Plugins
Expand Down
10 changes: 5 additions & 5 deletions develop-dotnet-plugins.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
Flow is written in C#, so plugins written in .NET platform can directly communicate with Flow without extra protocols.

## Initialization
## Initialisation

For C# Plugins, We recommend you use the [dotnet template](https://github.com/Flow-Launcher/dotnet-template) to generate a plugin template.

To be recognized as a Flow DotNet plugin, the directory needs to have at least two files
To be recognized as a Flow .NET plugin, the directory needs to have at least two files
1. [`plugin.json`](/plugin.json.md)
2. A Dotnet Assembly that implements **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** or **[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.
2. A .NET Assembly that implements **[IPlugin](/API-Reference/Flow.Launcher.Plugin/IPlugin.md)** or **[IAsyncPlugin](/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md)** (remember to reference [Flow.Launcher.Plugin](https://www.nuget.org/packages/Flow.Launcher.Plugin/) by Nuget). The plugin template will add the reference and create a `Main.cs` that implements `IPlugin`.

Find our API Reference [here](/API-Reference/Flow.Launcher.Plugin.md)
Find the [Flow Launcher Plugin API Reference](/API-Reference/Flow.Launcher.Plugin.md)


A sample CSharp Plugin [here](https://github.com/Flow-Launcher/plugin-samples)
See the [Flow Launcher C# plugin samples](https://github.com/Flow-Launcher/plugin-samples).

## IPlugin/IAsyncPlugin

Expand Down
Loading