Added tests, dev docs and README with examples.

Author: Jim (Dimitrios) Andrakakis

Dandraka.FuzzySubstringSearch/Dandraka.FuzzySubstringSearch.csproj

@@ -7,7 +7,7 @@
 
   <PropertyGroup>
     <PackageId>Dandraka.FuzzySubstringSearch</PackageId>
-	<Version>1.0.5</Version>	  
+	<Version>1.0.6</Version>	  
     <Authors>Jim (Dimitrios) Andrakakis</Authors>
     <Company>dandraka.com</Company>
 	<Copyright>Copyright (c) 2024 Jim (Dimitrios) Andrakakis</Copyright>
@@ -17,7 +17,7 @@
 	<PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageProjectUrl>https://github.com/dandraka/FuzzySubstringSearch</PackageProjectUrl>
     <RepositoryUrl>https://github.com/dandraka/FuzzySubstringSearch/</RepositoryUrl>    
-    <PackageReleaseNotes>Added tests and README with examples.</PackageReleaseNotes>
+    <PackageReleaseNotes>Added tests, dev docs and README with examples.</PackageReleaseNotes>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageTags>string text search substring fuzzy n-grams ngrams bigrams trigrams</PackageTags>
 	<PackageIcon>icon.png</PackageIcon>

README.md

@@ -59,87 +59,10 @@ When sequential is false this restriction does not apply:
 
 So the result is 2 matches / 3 total = 67%.
 
-# Dandraka.FuzzySubstringSearch assembly
+## Downloading
 
-## Dandraka.FuzzySubstringSearch namespace
+Please download the Nuget package [here](https://www.nuget.org/packages/Dandraka.FuzzySubstringSearch).
 
-| public type | description |
-| --- | --- |
-| class [LookingGlass] | N-gram case-insensitive text search. |
-
-# LookingGlass class
-
-N-gram case-insensitive text search.
-
-```csharp
-public class LookingGlass
-```
-
-## Public Members
-
-| name | description |
-| --- | --- |
-| [LookingGlass] | Creates a LookingGlass instance with sequential search. |
-| [LookingGlass] | Creates a LookingGlass instance. |
-| [NGram] | Performs an N-gram case-insensitive search. |
-
-## See Also
-
-* namespace [Dandraka.FuzzySubstringSearch]
-
-# LookingGlass constructor 
-
-Creates a LookingGlass instance with sequential search.
-
-```csharp
-public LookingGlass()
-```
-
-## See Also
-
-* class [LookingGlass]
-* namespace [Dandraka.FuzzySubstringSearch]
-
----
-
-# LookingGlass constructor 
-
-Creates a LookingGlass instance.
-
-```csharp
-public LookingGlass(bool isSequential)
-```
-
-| parameter | description |
-| --- | --- |
-| isSequential | Defines if search is limited to sequencial mode. |
-
-## See Also
-
-* class [LookingGlass]
-* namespace [Dandraka.FuzzySubstringSearch]
-
-# LookingGlass.NGram method
-
-Performs an N-gram case-insensitive search.
-
-```csharp
-public int NGram(string TargetString, string SearchString, int NGramSize)
-```
-
-| parameter | description |
-| --- | --- |
-| TargetString | The string in which search is being performed. Must not be null or empty. |
-| SearchString | The string sought within the target string. Must not be null or empty. |
-| NGramSize | The n-gram size, usually 2 or 3. Default is 3. Must be less or equal than the minimum of TargetString and SearchString length. |
-
-## Return Value
-
-An integer number between 0 and 100.
-Zero means that no part of the search string was found.
-100 means that the search string was found verbatim.
-
-## See Also
+## Development documentation
 
-* class [LookingGlass]
-* namespace [Dandraka.FuzzySubstringSearch]
+Please refer to the generated docs [here](https://github.com/dandraka/FuzzySubstringSearch/blob/main/docs/Dandraka.FuzzySubstringSearch.md).