From 97a9708c03f42dfa81fdc4d35f2496d42cfae6bd Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Sun, 25 Jun 2017 22:10:48 -0700 Subject: [PATCH] Recommend electron-forge in auto-updater, fix some Windows stuffs We should point people to electron-forge, it's the modern way to package Electron apps --- docs/api/auto-updater.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 9c743a0376dc..075f0bf93382 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -39,9 +39,9 @@ This is a requirement of `Squirrel.Mac`. On Windows, you have to install your app into a user's machine before you can use the `autoUpdater`, so it is recommended that you use the -[electron-winstaller][installer-lib], [electron-builder][electron-builder-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer. +[electron-winstaller][installer-lib], [electron-forge][electron-forge-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer. -When using [electron-winstaller][installer-lib] or [electron-builder][electron-builder-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app. +When using [electron-winstaller][installer-lib] or [electron-forge][electron-forge-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app. The installer generated with Squirrel will create a shortcut icon with an [Application User Model ID][app-user-model-id] in the format of @@ -50,8 +50,9 @@ The installer generated with Squirrel will create a shortcut icon with an same ID for your app with `app.setAppUserModelId` API, otherwise Windows will not be able to pin your app properly in task bar. -The server-side setup is also different from macOS. You can read the documents of -[Squirrel.Windows][squirrel-windows] to get more details. +Unlike Squirrel.Mac, Windows can host updates on S3 or any other static file host. +You can read the documents of [Squirrel.Windows][squirrel-windows] to get more details +about how Squirrel.Windows works. ### Linux @@ -131,7 +132,7 @@ from the normal quit event sequence. [squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows [installer]: https://github.com/electron/grunt-electron-installer [installer-lib]: https://github.com/electron/windows-installer -[electron-builder-lib]: https://github.com/electron-userland/electron-builder +[electron-forge-lib]: https://github.com/electron-userland/electron-forge [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx [electron-release-server]: https://github.com/ArekSredzki/electron-release-server [squirrel-updates-server]: https://github.com/Aluxian/squirrel-updates-server