build: include readme in nuget packages

Author: anthonyreilly

CHANGELOG.md

@@ -3,9 +3,11 @@
 ### 2025-06-10 v5.0.0
 
 * feat: branched off and removed LINQ project, as it is unlikely to become production ready in the new future
+* build: simplified library target to .NET Standard 2.0 for maximum compatibility.
 * build: remove unsupported frameworks, separately test each supported framework target
 * test: updated functional test in NullValueTests to avoid duplicate error on create
 * test: updated packages, updated deprecated async void methods
+* test: Tests target .NET Core 6.0-9.0
 
 ### 2025-02-24 v5.0.0-Beta
 

src/NetCoreForce.Client/NetCoreForce.Client.csproj

@@ -21,7 +21,13 @@
     <RepositoryType>$(RepositoryType)</RepositoryType>
     <RepositoryUrl>$(RepositoryUrl)</RepositoryUrl>
     <PackageReleaseNotes>$(PackageReleaseNotes)</PackageReleaseNotes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <PropertyGroup>
     <!-- Documentation -->
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
@@ -30,6 +36,7 @@
     <NoWarn>CS1591</NoWarn>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
   </PropertyGroup>
+
   <PropertyGroup Condition="'$(Configuration)'=='Release'">
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageOutputPath>$(SolutionDir)/packages</PackageOutputPath>
@@ -59,4 +66,4 @@
   <ItemGroup>
     <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
   </ItemGroup>
-</Project>
+</Project>

src/NetCoreForce.Client/README.md

@@ -1,22 +1,9 @@
-# NetCoreForce.Client
+# NetCoreForce 
 
-Current transactions supported:
-* Create object
-* Update object
-* Delete object
-* Get SOQL Query results
-* Get object by Id
-* SOSL Search
+## A .NET Standard and .NET Core Salesforce REST API integration library
+*This project is not offered, sponsored, or endorsed by Salesforce.*
 
-Metadata:
-* Org Limits
-* SObject Basic Information (basic object metadata)
-* SObject Describe (full object metadata)
-* Describe Global
-Metadata results have modeled/typed results
+Targets .NET Standard 2.0 - this means it will be generally compatible with .NET Framework 4.6.1+ and .NET Core 2.0+  
+For more info on .NET Standard 2.0 compatiblity [see the Microsoft documentation here](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
 
-Supported Auth Flows
-* Username/Password
-* Web Server
-* User Agent
-* Refresh Token
+Full tested support is for .NET Core 6.0 - 9.0 as tooling and tests target those.

src/NetCoreForce.ModelGenerator/NetCoreForce.ModelGenerator.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), build.props))\build.props" />
+  <Import
+    Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), build.props))\build.props" />
   <PropertyGroup>
     <AssemblyName>dotnet-modelgenerator</AssemblyName>
     <Product>NetCoreForce.ModelGenerator</Product>
@@ -10,7 +11,8 @@
     <!--NuGet-->
     <Authors>$(Authors)</Authors>
     <Copyright>$(Copyright)</Copyright>
-    <Description>NetCoreForce ModelGenerator tool to generate object models against a live Salesforce org.</Description>
+    <Description>NetCoreForce ModelGenerator tool to generate object models against a live
+      Salesforce org.</Description>
     <IsPackable>true</IsPackable>
     <PackageId>NetCoreForce.ModelGenerator</PackageId>
     <PackageLicenseExpression>$(PackageLicenseExpression)</PackageLicenseExpression>
@@ -23,8 +25,13 @@
     <PackAsTool>true</PackAsTool>
     <ToolCommandName>NetCoreForce.ModelGenerator</ToolCommandName>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <PropertyGroup Condition="'$(Configuration)'=='Release'">
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageOutputPath>$(SolutionDir)/packages</PackageOutputPath>

src/NetCoreForce.Models/NetCoreForce.Models.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), build.props))\build.props" />
+  <Import
+    Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), build.props))\build.props" />
   <PropertyGroup>
     <AssemblyName>NetCoreForce.Models</AssemblyName>
     <Product>NetCoreForce.Models</Product>
@@ -20,7 +21,13 @@
     <RepositoryType>$(RepositoryType)</RepositoryType>
     <RepositoryUrl>$(RepositoryUrl)</RepositoryUrl>
     <PackageReleaseNotes>$(PackageReleaseNotes)</PackageReleaseNotes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <PropertyGroup>
     <!-- Documentation -->
     <GenerateDocumentationFile>true</GenerateDocumentationFile>