Skip to content

Commit

Permalink
Add a package readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
craigktreasure committed Nov 16, 2023
1 parent f6ecfdf commit 2678bcc
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/Treasure.Utils.Argument/README.md
Original file line number Diff line number Diff line change
@@ -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);
}
```
2 changes: 2 additions & 0 deletions src/Treasure.Utils.Argument/Treasure.Utils.Argument.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit 2678bcc

Please sign in to comment.