add readme to package

vforteli · Aug 30, 2022 · 2af4aa7 · 2af4aa7
1 parent ca37b0f
commit 2af4aa7
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/FuzzySearchNet/FuzzySearchNet.csproj b/FuzzySearchNet/FuzzySearchNet.csproj
@@ -13,7 +13,7 @@
 
   <PropertyGroup>
     <PackageId>FuzzySearch.Net</PackageId>
-    <VersionPrefix>0.3.1</VersionPrefix>
+    <VersionPrefix>0.3.2</VersionPrefix>
     <Title>FuzzySearch.Net</Title>
     <Authors>Verner Fortelius</Authors>
     <Description>Fuzzy search library for finding strings in strings. Inspired by and attempts to be somewhat compatible with fuzzysearch for python https://github.com/taleinat/fuzzysearch</Description>
@@ -26,6 +26,10 @@
     <PackageTags>fuzzy search;levenshtein distance;dotnet;.net;c#;fuzzysearch.net</PackageTags>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="../README.md" Pack="true" PackagePath="/"/>
+  </ItemGroup>
 </Project>
diff --git a/README.md b/README.md
@@ -33,6 +33,12 @@ Searching for strings in strings
   if(FuzzySearch.Find(word, text, 2).Any()) {
     // do stuff
   }
+
+  // Use stream and asynchronously enumerate matches
+  await foreach (var match in FuzzySearch.FindLevenshteinAsync("somepattern", textstream))
+  {
+    // do stuff
+  }
 
 
   // Find returns a list of MatchResults with information about matches