From 6bcf4b1112e6657ddf4f1f5ad48ac640bc223b67 Mon Sep 17 00:00:00 2001 From: Lukas Geiger Date: Sat, 10 Dec 2016 20:23:33 +0100 Subject: [PATCH] :memo: Add instructions for native modules using prebuild --- docs/tutorial/using-native-node-modules.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 8ac1dc7cfee..51b256ab100 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -76,6 +76,16 @@ following things: * After you upgraded Electron, you usually need to rebuild the modules. * When in doubt, run `electron-rebuild` first. +## Modules that rely on `prebuild` + +[`prebuild`](https://github.com/mafintosh/prebuild) provides a way to easily +publish native Node modules with prebuilt binaries for multiple versions of Node +and Electron. + +If modules provide binaries for the usage in Electron, make sure to omit +`--build-from-source` and the `npm_config_build_from_source` environment +variable in order to take full advantage of the prebuilt binaries. + ## Modules that rely on `node-pre-gyp` The [`node-pre-gyp` tool][node-pre-gyp] provides a way to deploy native Node