Skip to content

Commit

Permalink
Adding node-webkit info to the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
saboya committed Jan 28, 2018
1 parent 3c5abcf commit b95fe57
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
12 changes: 9 additions & 3 deletions README.md
Expand Up @@ -11,7 +11,7 @@ $ npm install -g prebuild

## Features

* Builds native modules for any version of Node.js or Electron, without having to switch between different versions to do so. This works by only downloading the correct headers and telling `node-gyp` to use those instead of the ones installed on your system.
* Builds native modules for any version of Node.js, Electron or NW.js, without having to switch between different versions to do so. This works by only downloading the correct headers and telling `node-gyp` to use those instead of the ones installed on your system.
* Upload (`--upload`) prebuilt binaries to GitHub.
* Support for stripping (`--strip`) debug information. Strip command defaults to `strip` but can be overridden by the `STRIP` environment variable.
* Install prebuilt modules via [`prebuild-install`](https://github.com/mafintosh/prebuild-install).
Expand All @@ -37,6 +37,12 @@ To build against Electron headers, do:
prebuild -t 1.4.10 -r electron
```

To build against NW.js headers, do:

```
prebuild -t 0.26.6 -r node-webkit
```

See [`allTargets`](https://github.com/lgeiger/node-abi#usage) for all available versions.

For more options run `prebuild --help`. The prebuilds created are compatible with [node-pre-gyp](https://github.com/mapbox/node-pre-gyp)
Expand Down Expand Up @@ -99,7 +105,7 @@ $ prebuild -h
prebuild [options]
--target -t version (version to build or install for)
--runtime -r runtime (Node runtime [node or electron] to build or install for, default is node)
--runtime -r runtime (Node runtime [node, electron or node-webkit] to build or install for, default is node)
--all (prebuild for all known abi versions)
--upload -u [gh-token] (upload prebuilds to github)
--upload-all -u [gh-token] (upload all files from ./prebuilds folder to github)
Expand Down Expand Up @@ -127,7 +133,7 @@ Options:
- `.log` (optional)
- `.preinstall` (optional)
- `.gyp` Provide a custom `node-gyp` instance (optional)
- `.backend` Provide a custom `node-gyp` instance via string. Alternatives are `'node-gyp'` and `'node-ninja'` (optional, defaults to `'node-gyp'`)
- `.backend` Provide a custom `node-gyp` instance via string. Alternatives are `'node-gyp'`, `'node-ninja'` and `'nw-gyp'` (optional, defaults to `'node-gyp'`)
- `.args` Additional command line arguments to `node-gyp` (optional)
- `.debug` Pass in `--debug` on command line to gyp backend (optional)

Expand Down
2 changes: 1 addition & 1 deletion help.txt
@@ -1,7 +1,7 @@
prebuild [options]

--target -t version (version to build or install for)
--runtime -r runtime (Node runtime [node or electron] to build or install for, default is node)
--runtime -r runtime (Node runtime [node, electron or node-webkit] to build or install for, default is node)
--all (prebuild for all known abi versions)
--upload -u [gh-token] (upload prebuilds to github)
--upload-all -u [gh-token] (upload all files from ./prebuilds folder to github)
Expand Down

0 comments on commit b95fe57

Please sign in to comment.