Merge pull request #39 from tgharold/rework-build-process-nov18-10

Create README file for 'dotnet pack'

Author: tgharold

src/RecursiveDataAnnotationsValidation/README.md

@@ -0,0 +1,27 @@
+# RecursiveDataAnnotationsValidation
+
+Allows recursive validation of sub-objects in a class when using [DataAnnotations validation](https://docs.microsoft.com/en-us/aspnet/core/mvc/models/validation?view=aspnetcore-3.1) (also known as Attribute Validation).  The current version of .NET Core's attribute validation does not handle objects within objects (or collections of objects).  Therefore it is necessary to add some glue code to recurse through the object graph.
+
+## Installation
+
+### .NET Core
+
+    $ dotnet add package RecursiveDataAnnotationsValidation
+
+### Package Manager
+
+    PM> Install-Package RecursiveDataAnnotationsValidation
+
+## Usage
+
+Usage of the recursive validation is nearly identical to using the standard validator.
+
+    var validator = new RecursiveDataAnnotationValidator();
+    var validationResults = new List<ValidationResult>();
+    var result = validator.TryValidateObjectRecursive(sut, validationResults);
+    
+There are more examples in the [example](https://github.com/tgharold/RecursiveDataAnnotationsValidation/tree/master/examples) and [test](https://github.com/tgharold/RecursiveDataAnnotationsValidation/tree/master/test) projects.
+
+### SkipRecursiveValidationAttribute
+
+The [`[SkipRecursiveValidation]`](https://github.com/tgharold/RecursiveDataAnnotationsValidation/blob/master/src/RecursiveDataAnnotationsValidation/Attributes/SkipRecursiveValidation.cs) attribute can be used on properties where you do not want to recursively validate.  An example of this can be seen in [SkippedChildrenExample.cs](https://github.com/tgharold/RecursiveDataAnnotationsValidation/blob/master/test/RecursiveDataAnnotationsValidation.Tests/TestModels/SkippedChildrenExample.cs).

src/RecursiveDataAnnotationsValidation/RecursiveDataAnnotationsValidation.csproj

@@ -13,7 +13,7 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <RepositoryUrl>https://github.com/tgharold/RecursiveDataAnnotationsValidation</RepositoryUrl>
     <PackageTags>dataannotation validation validator</PackageTags>
-    <PackageReadmeFile>../README.md</PackageReadmeFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -25,4 +25,8 @@
     <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>