@benmerckx/binwrap
v0.2.2
Published
Package cross-platform binaries
Downloads
23
Readme
This package helps with distributing binaries via npm.
Usage
First, create your compiled binaries and make them available via HTTPS.
Now create your npm installer: Make a package.json
that looks like this:
{
"name": "myApp",
"version": "1.0.0",
"description": "Install myApp",
"preferGlobal": true,
"main": "index.js",
"scripts": {
"install": "binwrap-install",
"prepare": "binwrap-prepare",
"test": "binwrap-test",
"prepublish": "npm test"
},
"license": "BSD-3-Clause",
"files": [
"index.js",
"bin"
],
"bin": {
"myapp-cli": "bin/myapp-cli"
},
"dependencies": {
"binwrap": "^0.2.2"
}
}
Then create your index.js
file like this:
var binwrap = require("binwrap");
var path = require("path");
var packageInfo = require(path.join(__dirname, "package.json"));
var version = packageInfo.version;
var root = "https://dl.bintray.com/me/myApp/" + version;
module.exports = binwrap({
dirname: __dirname,
binaries: [
"myapp-cli"
],
urls: {
"darwin-x64": root + "/mac-x64.tgz",
"linux-x64": root + "/linux-x64.tgz",
"win32-x64": root + "/win-i386.zip",
"win32-ia32": root + "/win-i386.zip"
}
});
Then run npm test
to verify that your packages are published correctly.
Finally, run npm publish
when you are ready to publish your installer.