Update Readme with quick start

README.md

@@ -61,6 +61,103 @@ The models are built using the Marian/Bergamot framework and are designed to pro
 | Dutch | nl | ##NL |
 | Swedish | sv | ##SV |
 
+# Quick Start (QVAC SDK)
+
+The INTGEMM packs run out of the box with the [QVAC SDK](https://docs.qvac.tether.io/) using its built-in Bergamot NMT engine. The SDK runs on Node.js, Bare, and Expo, with native backends (Metal on macOS, Vulkan on Windows/Linux).
+
+**Requirements:** Node.js >= 22.17.
+
+## 1. Download the model
+
+Grab the Base INTGEMM packs (both directions) with the HuggingFace CLI:
+
+```bash
+pip install -U "huggingface_hub[cli]"
+
+huggingface-cli download <your-org>/TranslatePsy-Euro \
+  --include "en-xx/Base/intgemm/*" "xx-en/Base/intgemm/*" \
+  --local-dir ./TranslatePsy-Euro
+```
+
+This gives you:
+
+```text
+TranslatePsy-Euro/
+  en-xx/Base/intgemm/{model.intgemm.alphas.bin, vocab.spm}   # English -> European
+  xx-en/Base/intgemm/{model.intgemm.alphas.bin, vocab.spm}   # European -> English
+```
+
+Swap `Base` for `BaseMemory` or `Tiny` to trade quality for size, or drop `--include` to fetch every variant.
+
+## 2. Install the SDK
+
+```bash
+npm init -y && npm pkg set type=module
+npm install @qvac/sdk
+```
+
+## 3. Translate
+
+Save as `quickstart.mjs`:
+
+```js
+import path from "node:path";
+import { loadModel, translate, unloadModel } from "@qvac/sdk";
+
+const ROOT = "./TranslatePsy-Euro";
+
+// direction: "en-xx" (English -> European) or "xx-en" (European -> English)
+function load(direction, from, to) {
+  const dir = path.join(ROOT, direction, "Base", "intgemm");
+  return loadModel({
+    modelSrc: path.join(dir, "model.intgemm.alphas.bin"),
+    modelType: "nmt",
+    modelConfig: {
+      engine: "Bergamot",
+      from,
+      to,
+      srcVocabSrc: path.join(dir, "vocab.spm"),
+      dstVocabSrc: path.join(dir, "vocab.spm"),
+    },
+  });
+}
+
+async function translateText(modelId, text) {
+  const { text: out } = translate({ modelId, text, modelType: "nmt", stream: false });
+  return (await out).trim();
+}
+
+// English -> German: prepend the ##DE target tag (see Translation Directions).
+const ende = await load("en-xx", "en", "de");
+console.log(await translateText(ende, "##DE Good morning, how are you today?"));
+await unloadModel({ modelId: ende });
+
+// German -> English: no tag needed.
+const deen = await load("xx-en", "de", "en");
+console.log(await translateText(deen, "Guten Morgen, wie geht es Ihnen heute?"));
+await unloadModel({ modelId: deen });
+```
+
+```bash
+node quickstart.mjs
+```
+
+Output:
+
+```text
+Guten Morgen, wie geht es dir heute?
+Good morning. How are you doing today?
+```
+
+**Notes**
+
+- **English → European (`en-xx`):** prepend the target tag (`##DE`, `##FR`, `##ES`, …) to the source text, as listed under [Translation Directions](#english--european-en-xx).
+- **European → English (`xx-en`):** no tag required.
+- **European → European:** pivot through English — run `xx-en` first, then feed the English output (with the target tag) into `en-xx`.
+- Load a pack once and reuse the returned `modelId` for many translations; call `unloadModel` to free the memory when you're done.
+- For token-by-token streaming, pass `stream: true` and iterate `translate(...).tokenStream` instead.
+
+
 # Model Details
 
 ## Architecture