Skip to content

Commit

Permalink
docs(electron-updater): "Differences between electron-updater and bui…
Browse files Browse the repository at this point in the history
…lt-in autoUpdater"
  • Loading branch information
develar committed Jun 7, 2017
1 parent 12473d0 commit 5bb4df1
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions .idea/dictionaries/develar.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions docs/Auto Update.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@ See the [Publishing Artifacts](https://github.com/electron-userland/electron-bui

Simplified auto-update is supported on Windows if you use the default NSIS setup, but is not supported for Squirrel.Windows.

## Differences between electron-updater and built-in autoUpdater

* It doesn't require a dedicated release server.
* Code signature validation not only on macOS, but also on Windows.
* electron-builder produces and publishes all required metadata files and artifacts.
* Download progress supported on all platforms, including macOS.
* Actually, built-in autoUpdater is used inside on macOS.
* Different providers supported out of the box (GitHub, Bintray, Amazon S3, generic HTTP(s) server).
* You need only 2 lines of code to make it work.

## Quick Setup Guide

1. Install [electron-updater](https://www.npmjs.com/package/electron-updater) as an app dependency.
Expand Down
7 changes: 5 additions & 2 deletions packages/electron-updater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@ Linux support is [planned](https://github.com/electron-userland/electron-builder

## Differences between electron-updater and built-in autoUpdater

* Actually, autoUpdater is used inside (on macOS).
* It doesn't require a dedicated release server.
* Code signature validation on Windows.
* [electron-builder](https://github.com/electron-userland/electron-builder) produces and publishes all required metadata files and artifacts.
* Download progress supported on all platforms, including macOS.
* Actually, built-in autoUpdater is used inside on macOS.
* Different providers supported out of the box (GitHub, Bintray, Amazon S3, generic HTTP(s) server).
* You need only 2 lines of code to make it work.
* [electron-builder](https://github.com/electron-userland/electron-builder) produces and published all required metadata files and artifacts.

## Credits

Expand Down

0 comments on commit 5bb4df1

Please sign in to comment.