# node-webkit-mac-updater

> Update your node-webkit based Mac app with ease

Latest version **0.0.3** (published 2014-08-25) · 0 weekly downloads

## Install

```sh
npm install node-webkit-mac-updater
pnpm add node-webkit-mac-updater
yarn add node-webkit-mac-updater
bun add node-webkit-mac-updater
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2014-08-25 |
| First published | 2014-04-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 78 |
| Author | Tom Moor |
| Maintainers | sqwiggle |
| Keywords | node-webkit, mac, updater |

## Links

- npm: https://www.npmjs.com/package/node-webkit-mac-updater
- Repository: https://github.com/sqwiggle/node-webkit-mac-updater
- Issues: https://github.com/sqwiggle/node-webkit-mac-updater/issues
- npm.io page: https://npm.io/package/node-webkit-mac-updater

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) *

## Recent versions

- 0.0.3 (latest) — 2014-08-25
- 0.0.2 — 2014-05-15
- 0.0.1 — 2014-04-07

## README

# Node Webkit Updater

This package will update a deployed Mac application by downloading a dmg from a specific location, mounting it, copying the contents over the original (keeping code signatures) and cleaning up after itself.

## Installation

You'll want to install the latest stable package from NPM:

```js
npm install node-webkit-mac-updater
```

## Usage

It's upto your application to know whether an update is needed and where to find it. You can do this by periodically hitting an API endpoint under your control. Once you know an update is needed then simply let the updater know where to find the dmg. 

This gives you the oppertunity to ask the user if they wish to update or force an update in the background.

```js
var Updater = require('node-webkit-mac-updater');

var updater = new Updater({
    dmg_name: 'MyApp Installer',
    app_name: 'MyApp',
    source: {
        host: 's3.amazonaws.com',
        port: 80,
        path: '/myapp-releases/mac/app-0.2.dmg'
    }
});

updater.update(function(err){
    if (!err) console.log('App has been updated!');
});

```


## DMG Format

The DMG must be built so that MyApp.app is in the root of the folder structure. You may have other files in the archive but only MyApp.app will be copied. This tool works great for creating DMGs programatically:

https://github.com/sqwiggle/yoursway-create-dmg


## Future Development

In the future we will be developing this into a cross-platform updater, covering the quirks and formats required for each individual OS that node-webkit supports.

---
_Source: https://npm.io/package/node-webkit-mac-updater · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._