fix(demo), docs: Update readme, minor demo fix, and version bump to 1…

….0.1 (#5)

* fix(demo): fill matches table for more than 10 matches

* docs: fix topN docstring

* docs: add description of the query parameters

* chore(package): bump version to 1.0.1

demo/fuzzy-demo.js

@@ -509,7 +509,7 @@ function renderMatches(matches, searchDataConfig) {
 }
 
 function fillTableWithMatches(matches, searchDataConfig) {
-  for (let i = 0; i < matches.length; i++) {
+  for (let i = 0; i < Math.min(matches.length, 10); i++) {
     let row = tableBody.children[i];
     row.match = matches[i];
     row.children[1].textContent = searchDataConfig.getEntityString(matches[i].entity);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m31coding/fuzzy-search",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "license": "MIT",
   "description": "A fast, accurate and multilingual fuzzy search library.",
   "homepage": "https://github.com/m31coding/fuzzy-search",

readme.md

@@ -163,6 +163,14 @@ console.dir(result2);
 } */
 ```
 
+The following parameters are available when creating a query:
+
+| Parameter | Type | Default | Description |
+| --------- | ---- | ------- | ----------- |
+| string | string | - | The query string. |
+| topN | number | 10 | The maximum number of matches to return. Provide Infinity to return all matches. |
+| minQuality | number | 0.3 | The minimum quality of a match, ranging from 0 to 1. When set to zero, all terms that share at least one common n-gram with the query are considered a match. |
+
 If the data terms contain characters and strings in non-latin scripts (such as Arabic, Cyrillic, Greek, Han, ... see also [ISO 15924](https://en.wikipedia.org/wiki/ISO_15924)), the default configuration must be adjusted before creating the searcher:
 
 ```js

src/interfaces/query.ts

@@ -8,7 +8,7 @@ export class Query {
   public readonly string: string;
 
   /**
-   * The maximum number of matches to return. If undefined, all matches will be returned.
+   * The maximum number of matches to return. Provide Infinity to return all matches.
    */
   public readonly topN: number;