diff --git a/README.md b/README.md new file mode 100644 index 0000000..eaf803b --- /dev/null +++ b/README.md @@ -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("") +console.log(wfAlign(...)) +``` + +Where `` is the path from the site root ie. `./scripts/wfa.wasm`. This will depend on your project structure. \ No newline at end of file