21 lines
1.0 KiB
Markdown
21 lines
1.0 KiB
Markdown
# needLe
|
|
|
|
Fuzzy search engine for small text pieces, with Chinese/Japanese pronunciation support.
|
|
|
|
Available in [TypeScript](./packages/needle) and [C#](./dotnet). Click the link for detailed documentation.
|
|
|
|
See also [in-browser demo](https://needle.maigo.dev).
|
|
|
|
## Packages
|
|
|
|
| Platform | Package | Install |
|
|
|:--------:|:-------:|:-------:|
|
|
| Node.js / Browser | [@maigolabs/needle](https://www.npmjs.com/package/@maigolabs/needle) | `pnpm add @maigolabs/needle` |
|
|
| .NET Standard 2.0 | [MaigoLabs.NeedLe](https://www.nuget.org/packages/MaigoLabs.NeedLe) | `dotnet add package MaigoLabs.NeedLe` |
|
|
|
|
## The Name
|
|
|
|
The word "needle" is from the phrase [Needle in a Haystack](https://en.wikipedia.org/wiki/Needle_in_a_haystack). Normally, searching tasks are finding a small string ("needle") in a large string ("haystack"). However, this project is designed for searching in small strings (specifically, music names) instead of large strings. We are finding needles in needles.
|
|
|
|
The capitalized "L" is from the music name [needLe](https://projectsekai.fandom.com/wiki/NeedLe).
|