chore(readme): Updated docs with info about coordination numbers and …

…interim numbers. Updated option to be AllowInterimNumber rather than AllowInterim. Signed-off-by: Johannes Tegnér <[email protected]>
personnummer · Mar 12, 2023 · 98662c0 · 98662c0
1 parent 01c5584
commit 98662c0
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/Personnummer.Tests/InterimNumberTests.cs b/Personnummer.Tests/InterimNumberTests.cs
@@ -7,7 +7,7 @@ public class InterimNumberTests
     {
         private Personnummer.Options _opts = new Personnummer.Options()
         {
-            AllowInterim = true,
+            AllowInterimNumber = true,
         };
 
         [Theory]

diff --git a/Personnummer/Personnummer.cs b/Personnummer/Personnummer.cs
@@ -11,13 +11,13 @@ public struct Options
         {
             public Options()
             {
-                AllowInterim = false;
+                AllowInterimNumber = false;
                 AllowCoordinationNumber = true;
             }
 
             public bool AllowCoordinationNumber { get; set; } = true;
 
-            public bool AllowInterim { get; set; } = false;
+            public bool AllowInterimNumber { get; set; } = false;
         }
 
         #region Fields and Properties
@@ -68,7 +68,7 @@ public Personnummer(string ssn, Options? options = null)
             }
 
 
-            if (options.Value.AllowInterim == false && Regex.IsMatch(ssn.Trim(), InterimTest))
+            if (options.Value.AllowInterimNumber == false && Regex.IsMatch(ssn.Trim(), InterimTest))
             {
                 throw new PersonnummerException(
                     $"{ssn} contains non-integer characters and options are set to not allow interim numbers"
@@ -139,7 +139,7 @@ public Personnummer(string ssn, Options? options = null)
             }
 
             var num = groups["numbers"].Value;
-            if (options.Value.AllowInterim)
+            if (options.Value.AllowInterimNumber)
             {
                  num = Regex.Replace(num, InterimTest, "1");
             }

diff --git a/Readme.md b/Readme.md
@@ -67,6 +67,27 @@ using Personnummer;
 //=> false
 ```
 
+### Coordination numbers
+
+The package supports coordination numbers. This feature is enabled by default
+and can be disabled by passing an option object to the constructor, parse 
+or validate function.
+
+```csharp
+Personnummer.Parse("193405619996"); // True.
+Personnummer.Parse("193405619996", new { AllowCoordinationNumber = true }); // False.
+```
+
+### Interim / T -numbers
+
+The package supports interim (aka T) -numbers. This feature is not enabled by 
+default as they are commonly used, but can be enabled by passing an option object
+to the constructor, parse of validate function.
+
+```csharp
+Personnummer.Parse("20000101T220", new { AllowInterimNumber = true }); // True.
+```
+
 See `Personnummer.Test/PersonnummerTest.cs` for more examples.
 
 ## License