chore: Updated documentation and package metadata

RubenMateus · May 26, 2020 · b7e2342 · b7e2342
1 parent c772e48
commit b7e2342
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 10 deletions.
diff --git a/README.MD b/README.MD
@@ -17,10 +17,12 @@
 
 [![NuGet](https://img.shields.io/nuget/v/Sluggy.svg)](https://www.nuget.org/packages/Sluggy/)
 
-`dotnet add package Sluggy --version 2.0.1`
+`dotnet add package Sluggy --version 3.0.1`
 
 Sluggy is a configuration based class library designed to create friendly URL's.
 
+**Check release notes for more info on the latest changes.**
+
 ---
 
 ## Sluggy Unidecode
@@ -32,13 +34,20 @@ Sluggy is a configuration based class library designed to create friendly URL's.
 SluggyUnidecode is simple and powerful.
 Extends the Sluggy package by using the Unidecode.NET library for normalization.
 
+**Check release notes for more info on the latest changes.**
+
 ---
 
 ## QuickStart with Sluggy
 
 ### **There are 4 ways to use ToSlug()**
 
-#### The default is *new CompositeStrategy(new ToLowerInvariantStrategy(), new NormalizationStrategy())*
+#### The default strategies are:
+``` csharp
+NonAlphaNumericStrategy()
+ToLowerInvariantStrategy()
+NormalizationStrategy()
+```
 
 #### *Default separator is "-"*
 
@@ -53,7 +62,6 @@ using Sluggy;
 "Eu NãO GoStO de PãO Da Avó".ToSlug();
 // Output: "eu-nao-gosto-de-pao-da-avo"
 ```
-
 ---
 
 ### You can redefine the separator
@@ -110,7 +118,6 @@ using Sluggy;
 var separator = "/";
 
 // Defining the composite strategy
-
 var normalizationWithUpperCaseStrategy = new CompositeStrategy(
     new ToUpperCaseStrategy(),
     new NormalizationStrategy());

diff --git a/Sluggy.Tests/SluggyUnitTests.cs b/Sluggy.Tests/SluggyUnitTests.cs
@@ -21,7 +21,6 @@ public void ShouldThrowNullArgumentException()
         [InlineData("EU GOSTO DE TÁRTE", "tarte-tarte-tarte-tarte")]
         [InlineData("EU GOSTO", "tarte-tarte")]
         [InlineData("EU não GOSTO", "tarte-tarte-tarte")]
-        [InlineData("", "")]
         public void ShouldReturnSlugifiedWithMocked(string value, string expectation)
         {
             const string translated = "tarte";

diff --git a/Sluggy/Sluggy.csproj b/Sluggy/Sluggy.csproj
@@ -20,11 +20,11 @@ Breaking Changes:
 # Updated namespace for strategy classes to be more semantic when importing
 # Added NonAlphanumericStrategy for better support for urls and filenames</PackageReleaseNotes>
     <RepositoryType>Library</RepositoryType>
-    <Version>3.0.0</Version>
+    <Version>3.0.1</Version>
     <PackageIconUrl></PackageIconUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <AssemblyVersion>3.0.0.0</AssemblyVersion>
-    <FileVersion>3.0.0.0</FileVersion>
+    <AssemblyVersion>3.0.1.0</AssemblyVersion>
+    <FileVersion>3.0.1.0</FileVersion>
     <PackageIcon>sluggy.png</PackageIcon>
   </PropertyGroup>
 

diff --git a/Sluggy/Strategies/NonAlphaNumericStrategy.cs b/Sluggy/Strategies/NonAlphaNumericStrategy.cs
@@ -9,10 +9,10 @@ namespace Sluggy.Strategies
     public class NonAlphaNumericStrategy : ITranslationStrategy
     {
         /// <summary>
-        ///
+        /// This strategy is used for removing non alpha numeric characters from the provided text.
         /// </summary>
         /// <param name="text">The text to be translated.</param>
-        /// <returns></returns>
+        /// <returns>The transformed text.</returns>
         /// <exception cref="ArgumentNullException">Thrown when text is null.</exception>
         public string Translate(string text)
         {