grpc
/
grpc-node
mirror of https://github.com/grpc/grpc-node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #940 from agmt5989/patch-1 

Updated README.md
This commit is contained in:
Michael Lumish 2019-07-08 13:02:46 -07:00 committed by GitHub
parent fd91a29c5c 986979bda9
commit fde180aeb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/grpc-native-core/README.md
View File

@ -28,7 +28,7 @@ The `--build-from-source` option will work even when installing another package
The official electron documentation recommends to [build all of your native packages from source](https://electronjs.org/docs/tutorial/using-native-node-modules#modules-that-rely-on-node-pre-gyp). While the reasons behind this are technically good - many native extensions won't be packaged to work properly with electron - the gRPC source code is fairly difficult to build from source due to its complex nature, and we're also providing working electron pre-built binaries. Therefore, we recommend that you do not follow this model for using gRPC with electron. Also, for the same reason, `electron-rebuild` will always build from source. We advise you to not use this tool if you are depending on gRPC. Please note that there's not just one way to get native extensions running in electron, and that there's never any silver bullet for anything. The following instructions try to cater about some of the most generic ways, but different edge cases might require different methodologies.
The best to get gRPC to work with electron is to do this, possibly in your `postinstall` script of your `package.json` file:
The best way to get gRPC to work with electron is to do this, possibly in the `postinstall` script of your `package.json` file:
```
npm rebuild --target=2.0.0 --runtime=electron --dist-url=https://atom.io/download/electron