diff --git a/src/Treasure.Utils.Argument/README.md b/src/Treasure.Utils.Argument/README.md new file mode 100644 index 0000000..f9d794a --- /dev/null +++ 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 index e66cfbc..e86a5b8 100644 --- a/src/Treasure.Utils.Argument/Treasure.Utils.Argument.csproj +++ b/src/Treasure.Utils.Argument/Treasure.Utils.Argument.csproj @@ -5,12 +5,14 @@ Treasure.Utils true + README.md A utility library for dealing with arguments. arguments utility treasure +