fix: include instructions for CJS

algorandfoundation · Jan 21, 2025 · 7cbdf23 · 7cbdf23
1 parent 623b36e
commit 7cbdf23
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1 @@
+README.md
diff --git a/README.md b/README.md
@@ -33,6 +33,28 @@ $ yarn
 $ yarn test
 ```
 
+## Regarding CJS
+
+This library can be used in a CommonJS as a dynamic import:
+
+```ts
+;(async function () {
+  const hd = await import("@algorandfoundation/xhd-wallet-api");
+})();
+```
+
+Make sure to set your tsconfig.json so it is at least:
+
+```json
+{
+  "target": "es2020",
+  "module": "Node16",
+  "moduleResolution": "Node16"
+}
+```
+
+# Test
+
 ## Output
 
 ```shell