Add readme to nuget package

Author: LucHeart

ModuleBase/ModuleBase.csproj

@@ -11,10 +11,11 @@
         <PackageIcon>Icon512.png</PackageIcon>
         <IncludeSymbols>true</IncludeSymbols>
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+        <Description>OpenShock Desktop Module Framework Base. Install to make a module for OpenShock Desktop</Description>
     </PropertyGroup>
 
     <ItemGroup>
-        <None Include="..\README.md" Pack="true" PackagePath="\"/>
+        <None Include=".\README.md" Pack="true" PackagePath="\"/>
         <None Include="..\Desktop\wwwroot\images\Icon512.png" Pack="true" PackagePath="$(PackageIcon)" />
     </ItemGroup>
 

ModuleBase/README.md

@@ -0,0 +1,33 @@
+# OpenShock Desktop Module Base
+
+This module is the base for all OpenShock Desktop modules. It provides the basic structure and interfaces that all modules should implement.
+
+## Installation
+
+```bash
+dotnet add package OpenShock.Desktop.ModuleBase
+```
+
+## Usage
+
+You need to inherit the `DesktopModuleBase` class and add the `DesktopModuleAttribute` to your assembly.
+
+A minimal module would look like this:
+
+Note that the assembly attribute is needs to be outside a namespace to work.
+```csharp
+using OpenShock.Desktop.ModuleBase;
+using OpenShock.Desktop.ModuleBase.Navigation;
+
+[assembly:DesktopModule(typeof(ExampleDesktopModule), "openshock.desktop.modules.examplemodule", "Example Module")]
+namespace OpenShock.Desktop.Modules.ExampleModule;
+
+public class ExampleDesktopModule : DesktopModuleBase
+{
+    public override IReadOnlyCollection<NavigationItem> NavigationComponents { get; } = [];
+}
+```
+
+ 
+
+Or see the example module on how to use it.