add import instructions to README

This commit is contained in:
Arthur Lu 2024-10-24 18:29:50 +00:00
parent 547dffd8ee
commit aed3ac6f8f

11
README.md Normal file
View File

@ -0,0 +1,11 @@
# Using WFA-JS
Download `wfa.js` and `wfa.wasm`from [releases](https://git.tronnet.net/tronnet/WFA-JS/releases) to your project. Add to your script:
```
import wfa from "./wfa.js"
await wfa("<path to wasm>")
console.log(wfAlign(...))
```
Where `<path to wasm>` is the path from the site root ie. `./scripts/wfa.wasm`. This will depend on your project structure.