Skip to content

Commit c791673

Browse files
committed
chore: update readme
1 parent 6a23495 commit c791673

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ The traceback shows the indices of the haystack that were matched, useful for ge
5050

5151
See the [`AsciiOptions` struct](https://github.com/fjebaker/fuzzig/blob/a78afddec30b547643604aafaee202db6fc878f1/src/root.zig#L460-L466) for a list of available options.
5252

53+
> [!NOTE]
54+
> For Unicode support via [zg](https://codeberg.org/atman/zg), use `fuzzig.Unicode` instead.
55+
5356
## Design
5457

5558
The module defines an `Algorithm` generic type, which accepts the element type of the array to be fuzzy searched, the score type and values, and an algorithm implementation. The implementation must define an `eqlFunc`, a `scoreFunc` and a `bonusFunc` used to test for equality between tokens, for determining the score of two matching tokens, and for determining any in-places bonuses respectively.
@@ -81,7 +84,6 @@ Then add the module to your build step in `build.zig`:
8184
```zig
8285
// ...
8386
const fuzzig = b.dependency("fuzzig", .{}).module("fuzzig");
84-
8587
my_exe_or_lib.root_module.addImport("fuzzig", fuzzig);
8688
// ...
8789
```

0 commit comments

Comments
 (0)