From aed3ac6f8f10be77977ceaea76c2e6ee6e0b54d5 Mon Sep 17 00:00:00 2001
From: Arthur Lu <root@tronnet.net>
Date: Thu, 24 Oct 2024 18:29:50 +0000
Subject: [PATCH] add import instructions to README

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

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("<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.
\ No newline at end of file