Clearer wording

This commit is contained in:
Cheng Zhao 2017-12-19 15:39:57 +09:00
parent 8953042ee3
commit 4dee778212

View file

@ -109,11 +109,13 @@ using this API.
Restarts the app and installs the update after it has been downloaded. It
should only be called after `update-downloaded` has been emitted.
**Note 1:** `autoUpdater.quitAndInstall()` will close all application windows
first and only emit `before-quit` event on `app` after that. This is different
from the normal quit event sequence.
Under the hood calling `autoUpdater.quitAndInstall()` will close all application
windows first, and automatically call `app.quit()` after all windows have been
closed.
**Note 2:** If you don't call `autoUpdater.quitAndInstall()` after `update-downloaded` event has been emitted then you will get the updated app on the next start/run of your app.
**Note** If the application is quit without calling this API after the
`update-downloaded` event has been emitted, the application will still be
replaced by the updated one on the next run.
[squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac
[server-support]: https://github.com/Squirrel/Squirrel.Mac#server-support