electron-installer-zip/README.md

Create a zip file with support for symlinks required by electron on osx.

# electron-installer-zip [![travis][travis_img]][travis_url] [![npm][npm_img]][npm_url]

> Create a zip file with support for symlinks required by electron on osx.

## Installation

```
# For use in npm scripts
npm i electron-installer-zip --save-dev

# For use from cli
npm i electron-installer-zip -g
```

## Usage

```bash
electron-installer-zip <dir> <out>

Options:
  --verbose  Confused or trying to track down a bug and want lots of debug
             output?                                  [boolean] [default: false]
  --help     Show help                                                 [boolean]
```

```javascript
var zip = require('electron-installer-zip');

var opts = {
  dir: 'dist/MongoDB Compass-darwin-x64/MongoDB Compass.app',
  out: 'dist/'
};

zip(opts, function(err, res) {
  if (err) {
    console.error(err);
    process.exit(1);
  }
  console.log('Zip file written to: ', res);
});

```

## License

Apache 2.0

[travis_img]: https://img.shields.io/travis/mongodb-js/electron-installer-zip.svg
[travis_url]: https://travis-ci.org/mongodb-js/electron-installer-zip
[npm_img]: https://img.shields.io/npm/v/electron-installer-zip.svg
[npm_url]: https://npmjs.org/package/electron-installer-zip
[electron-packager]: https://github.com/maxogden/electron-packager
[appzip]: https://github.com/LinusU/node-appzip