Add README
This commit is contained in:
parent
56e7931a48
commit
272cac65a9
18
README.md
Normal file
18
README.md
Normal file
@ -0,0 +1,18 @@
|
||||
# bliss-js
|
||||
This repo provides Node.js bindings for [Bliss](https://github.com/Polochon-street/bliss-rs).
|
||||
|
||||
## Installation
|
||||
A package with prebuilt binaries for Linux (x86_64 and ARM64) is provided in the Gitea registry: [@bliss-rs/bliss-rs](https://gitea.antonlyap.pp.ua/antonlyap/-/packages/npm/@bliss-rs%2Fbliss-rs).
|
||||
|
||||
```shell
|
||||
npm i @bliss-rs/bliss-rs --registry=https://gitea.antonlyap.pp.ua/api/packages/antonlyap/npm/
|
||||
```
|
||||
|
||||
(the registry will be saved to your `package-lock.json` automatically)
|
||||
|
||||
## Usage
|
||||
```ts
|
||||
import { analyze, analyzeSync } from '@bliss-rs/bliss-rs';
|
||||
|
||||
await analyze("/path/to/track.mp3") // → { version: number; analysis: Float32Array }
|
||||
```
|
Loading…
Reference in New Issue
Block a user