Skip to content

Commit da41f2c

Browse files
committed
update plugin readme, include in nupkg
1 parent bb5e1d3 commit da41f2c

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<PackageTags>flowlauncher</PackageTags>
2727
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
2828
<PublishRepositoryUrl>true</PublishRepositoryUrl>
29+
<PackageReadmeFile>Readme.md</PackageReadmeFile>
2930
</PropertyGroup>
3031

3132
<PropertyGroup Condition="'$(APPVEYOR)' == 'True'">
@@ -56,7 +57,7 @@
5657
</PropertyGroup>
5758

5859
<ItemGroup>
59-
<None Include="README.md" />
60+
<None Include="Readme.md" Pack="true" PackagePath="\"/>
6061
<None Include="FodyWeavers.xml" />
6162
</ItemGroup>
6263

Flow.Launcher.Plugin/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
What does Flow.Launcher.Plugin do?
2-
====
1+
Reference this package to develop a plugin for [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher).
32

4-
* Defines base objects and interfaces for plugins
5-
* Plugin authors making C# plugins should reference this DLL via nuget
6-
* Contains commands and models that can be used by plugins
3+
Useful links:
4+
5+
* [General plugin development guide](https://www.flowlauncher.com/docs/#/plugin-dev)
6+
* [.Net plugin development guide](https://www.flowlauncher.com/docs/#/develop-dotnet-plugins)
7+
* [Package API Reference](https://www.flowlauncher.com/docs/#/API-Reference/Flow.Launcher.Plugin)

0 commit comments

Comments
 (0)