Skip to content

Commit 831b593

Browse files
committed
docs: minor formatting [skip ci]
1 parent 020ad35 commit 831b593

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ Blazing fast library for fuzzy filtering, matching, and other fuzzy things!
44

55
# Zadeh
66

7-
Zadeh is a blazing fast library for fuzzy filtering, matching, and other fuzzy things. Zadeh is a multi-threaded library written in C++ with the goal to search through a dataset with 1M entries in a few hundred milliseconds.
7+
Zadeh is a blazing fast library for fuzzy filtering, matching, and other fuzzy things. Zadeh is a multithreaded library written in C++ with the goal to search through a dataset with 1M entries in a few hundred milliseconds.
88

99
### features
1010

11-
- fuzzy filter through an array of candidates (`StringArrayFilterer`)
12-
- fuzzy filter through nested tree-like objects (`TreeFilterer`)
11+
- Fuzzy filter through an array of candidates (`StringArrayFilterer`)
12+
- Fuzzy filter through nested tree-like objects (`TreeFilterer`)
1313
- Special treatment for strings that have separators (space ` `, hyphen `-`, underline`_`)
1414
- Special treatment for path-like strings (string separated by `\` or `//`)
1515
- give an array of indices at which the query matches the given string (`match`)
1616
- score the given string against the given query (`score`)
1717
- give an HTML/Markdown string that highlights the range for which the match happens (`wrap`)
18-
- Allows setting the candidates only once using `StringArrayFilterer` and `TreeFilterer` classes, and then, perform `filter` multiple times, which is much more efficient than calling the `filter` or `filterTree` functions directly every time.
18+
- Allows setting the candidates only once using `StringArrayFilterer` and `TreeFilterer` classes, and then perform `filter` multiple times, which is much more efficient than calling the `filter` or `filterTree` functions directly every time.
1919
- Bindings for Nodejs (more to come)
2020

2121
# Usage
@@ -340,7 +340,7 @@ returns
340340

341341
Score the given string against the given query.
342342

343-
- `string` - The string the score.
343+
- `string` - the string to score.
344344
- `query` - The query to score the string against.
345345

346346
```js
@@ -424,7 +424,7 @@ Sort and filter the given candidates by matching them against the given query.
424424

425425
- `candidates` - An array of strings or objects.
426426
- `query` - A string query to match each candidate against.
427-
- `options` options. You should provide a `key` in the options if an array of objects are passed.
427+
- `options` - the options. You should provide a `key` in the options if an array of objects is passed.
428428

429429
Returns an array of candidates sorted by best match against the query.
430430

@@ -451,7 +451,7 @@ results = filter(candidates, "me", { key: "name" }) // [{name: 'Me', id: 2}, {na
451451

452452
# Comparison with other libraries
453453

454-
### Zadeh vs fuzzaldrin and fuzzaldrin-plus
454+
### Zadeh vs Fuzzaldrin and Fuzzaldrin-plus
455455

456456
API is backward compatible with Fuzzaldrin and Fuzzaldrin-plus. Additional functions are provided to achieve better performance that could suit your needs
457457

0 commit comments

Comments
 (0)