diff --git a/README.md b/README.md index b319951..4a4e93a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,28 @@ # smart-whisper -Whisper.cpp Node.js binding with auto model offloading. +Smart-Whisper is a native Node.js addon designed for efficient and streamlined interaction with the [whisper.cpp](https://github.com/ggerganov/whisper.cpp), with automatic model offloading and reloading and model manager. ## Features -- [x] Directly interact with whisper.cpp as Node.js native addon -- [x] Load model once, run inference multiple times -- [x] Auto model offloading and reloading -- [x] Model manager to automatically download and update models +- **Node.js Native Addon Interaction**: Directly interact with whisper.cpp, ensuring fast and efficient processing. +- **Single Model Load for Multiple Inferences**: Load the model once and perform multiple and parallel inferences, optimizing resource usage and reducing load times. +- **Automatic Model Offloading and Reloading**: Manages memory effectively by automatically offloading and reloading models as needed. +- **Model Manager**: Automates the process of downloading and updating models, ensuring that the latest models are always available. + +## Installation + +```sh +npm i smart-whisper +``` + +## Documentation + +The documentation is available at . ## Example +See [examples](./examples) for more examples. + ```ts import { Whisper } from "smart-whisper"; import { decode } from "node-wav"; @@ -41,3 +53,13 @@ function read_wav(file: string): Float32Array { return channelData[0]; } ``` + +## Links + +- [GitHub Repository](https://github.com/JacobLinCool/smart-whisper) +- [NPM Package](https://www.npmjs.com/package/smart-whisper) +- [Documentation](https://jacoblincool.github.io/smart-whisper/) + +## License + +[MIT](./LICENSE) diff --git a/package.json b/package.json index 74cb7b8..42d44d3 100644 --- a/package.json +++ b/package.json @@ -54,6 +54,10 @@ "type": "git", "url": "git+https://github.com/JacobLinCool/smart-whisper.git" }, + "homepage": "https://jacoblincool.github.io/smart-whisper/", + "bugs": { + "url": "https://github.com/JacobLinCool/smart-whisper/issues" + }, "lint-staged": { "*.{ts,js,json,yaml,yml}": [ "prettier --write"