Docs: add electron to bundlers section

If you're using asar, you'll also need to configure asarUnpack.
lovell · Jan 3, 2024 · 8cd8326 · nosferatu500 · Jan 4, 2024 · lovell
1 parent 0499f59
commit 8cd8326
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/install.md b/docs/install.md
@@ -231,6 +231,21 @@ custom:
         - npm install --os=linux --cpu=x64 sharp
 ```
 
+### electron
+
+Ensure sharp is unpacked from the ASAR archive file using the
+[asarUnpack](https://www.electron.build/configuration/configuration.html)
+option.
+
+```json
+{
+  "build": {
+    "asar": true,
+    "asarUnpack": ["**/node_modules/sharp/**/*"]
+  }
+}
+```
+
 ## TypeScript
 
 TypeScript definitions are published as part of