Add a package readme file

craigktreasure · Nov 16, 2023 · 29a0204 · 29a0204
1 parent b416bd3
commit 29a0204
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/src/Treasure.Utils.Argument/README.md b/src/Treasure.Utils.Argument/README.md
@@ -0,0 +1,18 @@
+# Treasure.Utils.Argument
+
+[![NuGet](https://img.shields.io/nuget/v/Treasure.Utils.Argument)](https://www.nuget.org/packages/Treasure.Utils.Argument/)
+[![NuGet](https://img.shields.io/nuget/dt/Treasure.Utils.Argument)](https://www.nuget.org/packages/Treasure.Utils.Argument/)
+
+Utilities for working with arguments with nullable awareness.
+
+```csharp
+using Treasure.Utils;
+
+public void SomeMethod(object? anObject, string? aString, object inheritedButUnused)
+{
+    Argument.MarkUsed(inheritedButUnused);
+    this.AnObject = Argument.NotNull(anObject);
+    this.AString = Argument.NotNullOrEmpty(aString);
+    this.AString = Argument.NotNullOrWhiteSpace(aString);
+}
+```
diff --git a/src/Treasure.Utils.Argument/Treasure.Utils.Argument.csproj b/src/Treasure.Utils.Argument/Treasure.Utils.Argument.csproj
@@ -5,12 +5,14 @@
     <RootNamespace>Treasure.Utils</RootNamespace>
 
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <Description>A utility library for dealing with arguments.</Description>
     <PackageTags>arguments utility treasure</PackageTags>
   </PropertyGroup>
 
   <ItemGroup>
     <None Include="$(RepoRootPath)LICENSE.txt" Pack="true" PackagePath="" />
+    <None Include="README.md" Pack="true" PackagePath="" />
   </ItemGroup>
 
   <ItemGroup>