updated readme

Author: Mayerch1

GithubUpdateCheck/GithubUpdateCheck.cs

@@ -5,6 +5,7 @@
 
 using System.Text.RegularExpressions;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 
 namespace Mayerch1.GithubUpdateCheck
 {
@@ -56,10 +57,11 @@ public enum CompareType
     /// The exception that is thrown if the version argument does not match the required pattern
     /// </summary>
     public class InvalidVersionException : ArgumentException {
-        
+
         /// <summary>
         /// Initializes a new instance of the <see cref="InvalidVersionException"/> class
         /// </summary>
+        [ExcludeFromCodeCoverage]
         public InvalidVersionException()
         {
         }
@@ -76,6 +78,7 @@ public InvalidVersionException(String message) : base(message)
         /// </summary>
         /// <param name="message"></param>
         /// <param name="innerException"></param>
+        [ExcludeFromCodeCoverage]
         public InvalidVersionException(string message, Exception innerException) : base(message, innerException)
         {
         }
@@ -177,6 +180,7 @@ public GithubUpdateCheck(string Username, string Repository, CompareType compare
         /// </summary>
         /// <param name="obj">other object</param>
         /// <returns>False if objects are not the same type. Otherwise behaves like ==</returns>
+        [ExcludeFromCodeCoverage]
         public override bool Equals(object obj)
         {
             return Equals(obj as GithubUpdateCheck);
@@ -199,6 +203,7 @@ public bool Equals(GithubUpdateCheck other)
         /// Get the hash code of the object (generated by VS refactoring)
         /// </summary>
         /// <returns></returns>
+        [ExcludeFromCodeCoverage]
         public override int GetHashCode()
         {
             var hashCode = -1134592763;

GithubUpdateCheckTest/UnitTestBoolean.cs

@@ -2,6 +2,7 @@
 
 using Mayerch1.GithubUpdateCheck;
 using System.Threading.Tasks;
+using System.Diagnostics.CodeAnalysis;
 
 namespace GithubUpdateCheckTest
 {
@@ -11,6 +12,7 @@ namespace GithubUpdateCheckTest
     /// This unit test can take more than 20s runtime
     /// </summary>
     [TestClass]
+    [ExcludeFromCodeCoverage]
     public class UnitTestBoolean
     {
         [TestMethod]

GithubUpdateCheckTest/UnitTestGeneral.cs

@@ -2,6 +2,7 @@
 
 using Mayerch1.GithubUpdateCheck;
 using System.Threading.Tasks;
+using System.Diagnostics.CodeAnalysis;
 
 namespace GithubUpdateCheckTest
 {
@@ -11,6 +12,7 @@ namespace GithubUpdateCheckTest
     /// This unit test can take more than 20s runtime
     /// </summary>
     [TestClass]
+    [ExcludeFromCodeCoverage]
     public class UnitTestGeneral
     {
 

GithubUpdateCheckTest/UnitTestIncremental.cs

@@ -2,6 +2,7 @@
 
 using Mayerch1.GithubUpdateCheck;
 using System.Threading.Tasks;
+using System.Diagnostics.CodeAnalysis;
 
 namespace GithubUpdateCheckTest
 {
@@ -11,6 +12,7 @@ namespace GithubUpdateCheckTest
     /// This unit test can take more than 20s runtime
     /// </summary>
     [TestClass]
+    [ExcludeFromCodeCoverage]
     public class UnitTestIncremental
     {
         [TestMethod]

README.md

@@ -1,41 +1,67 @@
 # GithubUpdateCheck
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+ 
+[![Nuget](https://img.shields.io/nuget/v/Mayerch1.GithubUpdateCheck)](https://www.nuget.org/packages/Mayerch1.GithubUpdateCheck/)
+ 
+[![GitHub release](https://img.shields.io/github/release/mayerch1/GithubUpdateCheck.svg)](https://github.com/mayerch1/GithubUpdateCheck/releases/latest)
+
 NuGet package to check if an update is available. Always compares to the latest github release
 
+
 ## Usage
 Create an instance of the `GithubUpdateCheck` and specify your Github username and Github repository, as seen in the url.
+
+
 ```cs
+using Mayerch1.GithubUpdateCheck;
+
 GithubUpdateCheck update = new GithubUpdateCheck("Mayerch1", "GithubUpdateCheck");
 bool isUpdate = update.IsUpdateAvailable("1.0.0", VersionChange.Minor);
 bool isAsyncUpdate = await update.IsUpdateAvailable("1.0.0.5", VersionChange.Revision);
 ```
 
+---
+
+### Incremental Compare
+The default constructor is implicite setting the compare type to `CompareType.Incremental`.
+Alternatively call
+```cs
+GithubUpdateCheck update = new GithubUpdateCheck("Mayerch1", "GithubUpdateCheck", CompareType.Incremental);
+```
+
 The version will be compared to the latest release on Github (e.g. https://github.com/Mayerch1/GithubUpdateCheck/releases/latest). 
 Allowed are the following patterns
 ```
 1.0.0
 1.0.0.0
 
-v.1.0.0.0
 v.1.0.0
-
-v1.0.0.0
 v1.0.0
-```
-(`v` can be any non-digit)
-The version string and the tag of the github release must comply with those patterns, otherwise a `InvalidVersionException` will be thrown.
 
-The second argument `VersionChange changeLevel` specifies the level of comparison.
+1.0.0.[...].5 (any amount of '.' seperators)
+```
+`v` can be any non-digit and the version (local and repository) must comply with those patterns, otherwise a `InvalidVersionException` will be thrown 
 
+The second argument `VersionChange` specifies the level of comparison.
 
 </br>For `Major`, only the first number will be compared (x.0.0.0)
 </br>For `Minor`, the first and second number will be compared (x.y.0.0)
 </br>For `Build`, the numbers 1-3 will be compared (x.y.z.0)
 </br>For `Revision`, all numbers will be compared (x.y.z.a)
 
+If the version number if exceeding this enum, simply pass an integer `...IsUpdateAvailable("1.0.0.0.9", (VersionChange)5);`. The index is 1-offset from the Major version and will be corrected if it is too big for the present number.
 
-
-All numbers below the specified level (all 0 is this example) will be ignored.
-If the remote or local version has a lower level than the specified compare Method (e.g. `1.2.0` at `Revision`), only 
-the present version levels will be compared.
+All numbers below the specified level will be ignored.
 
 The prefix `v.` can be present on none, one or both sides.
+
+---
+
+### Boolean Compare
+If the used version system does not match the "Incremental" Compare, you can use the boolean compare.
+```cs
+GithubUpdateCheck update = new GithubUpdateCheck("Mayerch1", "GithubUpdateCheck", CompareType.Boolean);
+```
+The class will then compare both version strings (local and remote) and will assume an available update as 
+soon as they are not equal.