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

Improve grammar and punctuation of auto-updater.md

Browse source 
Improve the grammar, sentence structure, punctuation and formatting of
`auto-updater.md`.
This commit is contained in:
Jeffrey Morgan 2015-07-23 17:57:42 +01:00
parent 452619990e
commit d138c2970c
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -3,9 +3,9 @@
**This module has only been implemented for OS X.** **This module has only been implemented for OS X.**
Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer) Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer)
for building a Windows installer for your app. to build a Windows installer for your app.
The `auto-updater` module is a simple wrap around the The `auto-updater` module is a simple wrapper around the
[Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) framework. [Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) framework.
Squirrel.Mac requires that your `.app` folder is signed using the Squirrel.Mac requires that your `.app` folder is signed using the
@ -26,11 +26,11 @@ body so that your server has the context it needs in order to supply the most
suitable update. suitable update.
The update JSON Squirrel requests should be dynamically generated based on The update JSON Squirrel requests should be dynamically generated based on
criteria in the request, and whether an update is required. Squirrel relies criteria in the request and whether an update is required. Squirrel relies
on server side support for determining whether an update is required, see on server-side support to determine whether an update is required. See
[Server Support](#server-support). [Server Support](#server-support).
Squirrel's installer is also designed to be fault tolerant, and ensure that any Squirrel's installer is designed to be fault tolerant and ensures that any
updates installed are valid. updates installed are valid.
## Update Requests ## Update Requests
@ -40,11 +40,11 @@ update checking. `Accept: application/json` is added to the request headers
because Squirrel is responsible for parsing the response. because Squirrel is responsible for parsing the response.
For the requirements imposed on the responses and the body format of an update For the requirements imposed on the responses and the body format of an update
response see [Server Support](#server-support). response, see [Server Support](#server-support).
Your update request must *at least* include a version identifier so that the Your update request must *at least* include a version identifier so that the
server can determine whether an update for this specific version is required. It server can determine whether an update for this specific version is required. It
may also include other identifying criteria such as operating system version or may also include other identifying criteria, such as operating system version or
username, to allow the server to deliver as fine grained an update as you username, to allow the server to deliver as fine grained an update as you
would like. would like.
@ -64,7 +64,7 @@ autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVer
Your server should determine whether an update is required based on the Your server should determine whether an update is required based on the
[Update Request](#update-requests) your client issues. [Update Request](#update-requests) your client issues.
If an update is required your server should respond with a status code of If an update is required, your server should respond with a status code of
[200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) and include the [200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) and include the
[update JSON](#update-json-format) in the body. Squirrel **will** download and [update JSON](#update-json-format) in the body. Squirrel **will** download and
install this update, even if the version of the update is the same as the install this update, even if the version of the update is the same as the
@ -89,29 +89,29 @@ to the update request provided:
} }
``` ```
The only required key is "url", the others are optional. The only required key is "url"; the others are optional.
Squirrel will request "url" with `Accept: application/zip` and only supports Squirrel will request "url" with `Accept: application/zip` and only supports
installing ZIP updates. If future update formats are supported their MIME type installing ZIP updates. If future update formats are supported their MIME type
will be added to the `Accept` header so that your server can return the will be added to the `Accept` header so that your server can return the
appropriate format. appropriate format.
`pub_date` if present must be formatted according to ISO 8601. `pub_date` (if present) must be formatted according to ISO 8601.
## Event: error ## Event: error
* `event` Event * `event` Event
* `message` String * `message` String
Emitted when there is an error updating. Emitted when there is an error while updating.
## Event: checking-for-update ## Event: checking-for-update
Emitted when checking for update has started. Emitted when checking for an update has started.
## Event: update-available ## Event: update-available
Emitted when there is an available update, the update would be downloaded Emitted when there is an available update. The update is downloaded
automatically. automatically.
## Event: update-not-available ## Event: update-not-available
@ -127,17 +127,17 @@ Emitted when there is no available update.
* `updateUrl` String * `updateUrl` String
* `quitAndUpdate` Function * `quitAndUpdate` Function
Emitted when update has been downloaded, calling `quitAndUpdate()` would restart Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart
the application and install the update. the application and install the update.
## autoUpdater.setFeedUrl(url) ## autoUpdater.setFeedUrl(url)
* `url` String * `url` String
Set the `url` and initialize the auto updater. The `url` could not be changed Set the `url` and initialize the auto updater. The `url` cannot be changed
once it is set. once it is set.
## autoUpdater.checkForUpdates() ## autoUpdater.checkForUpdates()
Ask the server whether there is an update, you have to call `setFeedUrl` before Ask the server whether there is an update. You must call `setFeedUrl` before
using this API. using this API.