docs: document toHTML

eik-lib · Oct 9, 2024 · c5e0775 · c5e0775
1 parent 4576ddd
commit c5e0775
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -257,6 +257,33 @@ await client.load();
 client.base(); // http://localhost:8080/assets
 ```
 
+### .toHTML()
+
+Constructs an HTML import map script tag for use in the document head when doing import mapping.
+
+```js
+const client = new Eik({
+	loadMaps: true,
+	...
+});
+await client.load();
+
+const html = `
+	<html>
+	<head>
+		...
+		${client.toHTML()}
+		...
+	</head>
+	<body>
+		...
+	</body>
+	</html>
+`;
+```
+
+Due to browsers being restricted to a single import map, all import maps registered in eik.json or package.json will be merged down into a single import map with last in winning in case of duplicate keys.
+
 ## License
 
 Copyright (c) 2021 FINN.no