From a4e9d0bdeecc7a31c2d3b72f26de6f89502417c5 Mon Sep 17 00:00:00 2001
From: Dennis Diatlov <dennis@gear-tech.io>
Date: Thu, 12 Dec 2024 15:57:21 +0000
Subject: [PATCH] [net]build(nuget): add NuGet package readme and other info
 for Sails.ClientGenerator

---
 .../Sails.DemoClient/Sails.DemoClient.csproj  |  4 ++-
 net/src/Sails.ClientGenerator/README.md       | 28 +++++++++++++++++++
 .../Sails.ClientGenerator.csproj              |  9 +++++-
 3 files changed, 39 insertions(+), 2 deletions(-)
 create mode 100644 net/src/Sails.ClientGenerator/README.md

diff --git a/net/examples/Sails.DemoClient/Sails.DemoClient.csproj b/net/examples/Sails.DemoClient/Sails.DemoClient.csproj
index d2b38315..1e75467c 100644
--- a/net/examples/Sails.DemoClient/Sails.DemoClient.csproj
+++ b/net/examples/Sails.DemoClient/Sails.DemoClient.csproj
@@ -10,7 +10,9 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(UseSailsProjectRefences)' != 'true'">
-    <PackageReference Include="Sails.ClientGenerator" />
+    <PackageReference Include="Sails.ClientGenerator">
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="Sails.Net" />
     <PackageReference Include="Substrate.NET.API" VersionOverride="$(SubstrateNetApiVersionOverride)" Condition="'$(SubstrateNetApiVersionOverride)' != ''" />
   </ItemGroup>
diff --git a/net/src/Sails.ClientGenerator/README.md b/net/src/Sails.ClientGenerator/README.md
new file mode 100644
index 00000000..b6d6e76a
--- /dev/null
+++ b/net/src/Sails.ClientGenerator/README.md
@@ -0,0 +1,28 @@
+Sails.ClientGenerator
+=====================
+
+A library generating .NET code for communicating with programs written using
+[Sails](https://github.com/gear-tech/sails?tab=readme-ov-file#sails-) framework
+based on their IDL files. The generated code relies on abstractions provided by
+[Sails.Net](https://www.nuget.org/packages/Sails.Net).
+
+### Usage
+
+In the `csproj` file of the project willing to use generated client code, add:
+```xml
+<ItemGroup>
+  <!-- IDL file obtained from Sails program -->
+  <AdditionalFile Include="demo.idl" />
+</ItemGroup>
+
+<ItemGroup>
+  <PackageReference Include="Sails.ClientGenerator">
+      <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+  <PackageReference Include="Sails.Net" />
+</ItemGroup>
+```
+This will generate .NET code for the client which will be found under
+`Dependencies -> Analyzers -> Sails.ClientGenerator -> Sails.ClientGenerator.SailsClientGenerator`.
+Discover how the generated code can be used via exploring
+[tests](https://github.com/gear-tech/sails/tree/master/net/tests/Sails.DemoClient.Tests).
diff --git a/net/src/Sails.ClientGenerator/Sails.ClientGenerator.csproj b/net/src/Sails.ClientGenerator/Sails.ClientGenerator.csproj
index d5dfcbd0..1694dfa8 100644
--- a/net/src/Sails.ClientGenerator/Sails.ClientGenerator.csproj
+++ b/net/src/Sails.ClientGenerator/Sails.ClientGenerator.csproj
@@ -7,11 +7,18 @@
     <IsRoslynComponent>true</IsRoslynComponent>
     <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     <NoWarn>$(NoWarn);NU5128</NoWarn>
-    <Description>Code generator for Sails.Net.</Description>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Description>Code generator for clients to communictae with Sails programs</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageLicenseExpression>MIT OR Apache-2.0</PackageLicenseExpression>
+    <PackageTags>Sails, Vara, Gear, Substrate</PackageTags>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="/" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis" />
     <PackageReference Include="PolySharp" />