A drop-in module that adds autoUpdating capabilities to Electron apps
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore a start Apr 18, 2018
index.js console.debug is not always a thing Apr 18, 2018
package.json add repository URL Apr 18, 2018
readme.md rename it Apr 18, 2018
test.js a start Apr 18, 2018

readme.md

🚧 WIP NOTHING TO SEE HERE YET 🚧

update-electron-app

A drop-in module that adds autoUpdating capabilities to Electron apps

Installation

npm i update-electron-app

Usage

Drop this anywhere in your main process:

require('update-electron-app')({
  repo: 'ummoji/ummoji-desktop'
})

The module will automatically wait for your app's ready event to fire.

API

update(options)

Options:

  • repo String (required) - A GitHub repository in the format owner/repo
  • host String (optional) - Defaults to https://electron-update-server.herokuapp.com
  • updateInterval String (optional) - How frequently to check for updates. Defaults to 1 minute
  • debug Boolean (optional) - Display debug output. Defaults to true

Tests

npm install
npm test

License

MIT