Merge pull request #9 from crozone/feature/2.2.1

Release v2.2.1

FormatWith/FormatWith.csproj

@@ -1,4 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
+
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Title>FormatWith</Title>
@@ -7,7 +8,7 @@
     <AssemblyName>FormatWith</AssemblyName>
     <AssemblyTitle>FormatWith</AssemblyTitle>
     <PackageId>FormatWith</PackageId>
-    <VersionPrefix>2.2.0</VersionPrefix>
+    <VersionPrefix>2.2.1</VersionPrefix>
     <Authors>Ryan Crosby</Authors>
     <Copyright>Copyright © Ryan Crosby 2017</Copyright>
     <PackageTags>named string formatter extension NetStandard 2.0</PackageTags>
@@ -23,6 +24,15 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <RepositoryUrl>https://github.com/crozone/FormatWith</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <PackageReleaseNotes>Added handler overload to FormatWith and FormattableWith.</PackageReleaseNotes>
+    <PackageReleaseNotes>Include XML documentation in package.</PackageReleaseNotes>
   </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>bin\Debug\netstandard2.0\FormatWith.xml</DocumentationFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <DocumentationFile>bin\Release\netstandard2.0\FormatWith.xml</DocumentationFile>
+  </PropertyGroup>
+
 </Project>

FormatWith/StringExtensions.cs

@@ -4,9 +4,13 @@
 using System.Text;
 using FormatWith.Internal;
 using System.Runtime.CompilerServices;
+using System.Collections;
 
 namespace FormatWith
 {
+    /// <summary>
+    /// The string extensions provided by FormatWith for string formatting.
+    /// </summary>
     public static class StringExtensions
     {
         #region FormatWith Overloads
@@ -100,10 +104,6 @@ public static string FormatWith(
         /// </summary>
         /// <param name="formatString">The format string, containing keys like {foo}</param>
         /// <param name="replacements">An <see cref="IDictionary"/> with keys and values to inject into the string</param>
-        /// <param name="missingKeyBehaviour">The behaviour to use when the format string contains a parameter that is not present in the lookup dictionary</param>
-        /// <param name="fallbackReplacementValue">When the <see cref="MissingKeyBehaviour.ReplaceWithFallback"/> is specified, this string is used as a fallback replacement value when the parameter is present in the lookup dictionary.</param>
-        /// <param name="openBraceChar">The character used to begin parameters</param>
-        /// <param name="closeBraceChar">The character used to end parameters</param>
         /// <returns>The formatted string</returns>
         public static string FormatWith(this string formatString, IDictionary<string, object> replacements)
         {
@@ -343,7 +343,7 @@ public static FormattableString FormattableWith(
         #endregion
 
         /// <summary>
-        /// Gets an <see cref="IEnumerable{string}"/> that will return all format parameters used within the format string.
+        /// Gets an <see cref="IEnumerable{String}"/> that will return all format parameters used within the format string.
         /// </summary>
         /// <param name="formatString">The format string to be parsed</param>
         /// <param name="openBraceChar">The character used to begin parameters</param>

README.md

@@ -1,6 +1,6 @@
 # FormatWith
 
-[![NuGet](https://img.shields.io/badge/nuget-2.2.0-green.svg)](https://www.nuget.org/packages/FormatWith/)
+[![NuGet](https://img.shields.io/badge/nuget-2.2.1-green.svg)](https://www.nuget.org/packages/FormatWith/)
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()
 
 A set of string extension methods for performing {named} {{parameterized}} string formatting, written for NetStandard 2.0.