mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3292 from ggamel/patch-2

Browse source 
Update auto-updater.md to improve readability
This commit is contained in:
Cheng Zhao 2015-11-02 20:30:47 +08:00
commit b5f7c433c6
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/api/auto-updater.md
View file

@ -4,27 +4,27 @@ This module provides an interface for the `Squirrel` auto-updater framework.
## Platform notices ## Platform notices
Though `autoUpdater` provides an uniform API for different platforms, there are Though `autoUpdater` provides a uniform API for different platforms, there are
still some subtle differences on each platform. still some subtle differences on each platform.
### OS X ### OS X
On OS X the `autoUpdater` module is built upon [Squirrel.Mac][squirrel-mac], you On OS X, the `autoUpdater` module is built upon [Squirrel.Mac][squirrel-mac], meaning you
don't need any special setup to make it work. For server-side requirements, you don't need any special setup to make it work. For server-side requirements, you
can read [Server Support][server-support]. can read [Server Support][server-support].
### Windows ### Windows
On Windows you have to install your app into user's machine before you can use On Windows, you have to install your app into a user's machine before you can use
the auto-updater, it is recommended to use [grunt-electron-installer][installer] the auto-updater, so it is recommended to use [grunt-electron-installer][installer]
module to generate a Windows installer. module to generate a Windows installer.
The server-side setup is also different from OS X, you can read the documents of The server-side setup is also different from OS X. You can read the documents of
[Squirrel.Windows][squirrel-windows] to get more details. [Squirrel.Windows][squirrel-windows] to get more details.
### Linux ### Linux
There is not built-in support for auto-updater on Linux, it is recommended to There is not built-in support for auto-updater on Linux, so it is recommended to
use the distribution's package manager to update your app. use the distribution's package manager to update your app.
## Events ## Events
@ -84,7 +84,7 @@ using this API.
### `autoUpdater.quitAndInstall()` ### `autoUpdater.quitAndInstall()`
Restarts the app and install the update after it has been downloaded. It should Restarts the app and installs the update after it has been downloaded. It should
only be called after `update-downloaded` has been emitted. only be called after `update-downloaded` has been emitted.
[squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac [squirrel-mac]: https://github.com/Squirrel/Squirrel.Mac