From 0440b02622ea579c9294a1159aca748c5364aca6 Mon Sep 17 00:00:00 2001 From: Keitaroh Kobayashi Date: Mon, 6 Jan 2025 08:50:31 +0900 Subject: [PATCH] Update README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c00a79..01edc10 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A Node.js module to detect audio features in an streaming audio source. The detector is written in Rust, and provides a Writable / Async Iterator interface to NodeJS code. > [!WARNING] -> This is very, very alpha code. The interfaces may change at any time. +> This is very, very alpha code. The interfaces may change at any time. The audio matching logic will also be changing heavily. At this time, the detector code assumes 16-bit 16kHz signed-integer raw audio data. Providing anything else will probably result in garbage output. @@ -23,6 +23,13 @@ for await (const item of detector) { } ``` +> [!TIP] +> `score` is an arbitrary value between 0 and 1. Values closer to 1 represent high similarity, but the scale is not linear. Use with caution. + +## The matching algorithm + +...I will write this later... + ## Building Building this package requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).