Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
keichan34 committed Jan 5, 2025
1 parent 13399ae commit 0440b02
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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).
Expand Down

0 comments on commit 0440b02

Please sign in to comment.