Neolithic Prancing Minotaurs

    electron-update-notification
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.0 • Public • Published

    electron-update-notification

    npm

    Motivation

    update-electron-app is an auto updating solution for open source Electron apps. It is awesome but has some limitations:

    • Linux is not supported currently
    • For macOS, Apple Developer Program is required (for code sign) to process update

    electron-update-notification comes to help in these cases. Instead of downloading installer automatically, it simply notifies user to go to GitHub release page when updates available.

    Installation

    npm install electron-update-notification

    Usage

    import { setUpdateNotification } from 'electron-update-notification'
     
    setUpdateNotification({
      repository: 'user/repo', // Optional, use repository field of package.json if not specified
      token: '', // Optional, GitHub access token
    })

    Use it with update-electron-app:

    switch (process.platform) {
      case 'darwin':
      case 'win32':
        require('update-electron-app')()
        break
      default:
        require('electron-update-notification').setUpdateNotification({
          token: '',
        })
    }

    License

    MIT

    Keywords

    none

    Install

    npm i electron-update-notification

    DownloadsWeekly Downloads

    3

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    5.41 kB

    Total Files

    5

    Last publish

    Collaborators

    • pd4d10