Skip to content

Commit

Permalink
Improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
popod committed Mar 1, 2018
1 parent dedc0e9 commit 130311e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
8 changes: 3 additions & 5 deletions docs/auto-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,12 @@ Start downloading update manually. You can use this method if `autoDownload` opt
#### `appUpdater.setFeedURL(options)`
Configure update provider. If value is `string`, [GenericServerOptions](/configuration/publish.md#genericserveroptions) will be set with value as `url`.


- options <code>[PublishConfiguration](/configuration/publish.md#publishconfiguration)</code> | <code>String</code> | <code>[GithubOptions](/configuration/publish.md#githuboptions)</code> | <code>[S3Options](/configuration/publish.md#s3options)</code> | <code>[SpacesOptions](/configuration/publish.md#spacesoptions)</code> | <code>[GenericServerOptions](/configuration/publish.md#genericserveroptions)</code> | <code>[BintrayOptions](/configuration/publish.md#bintrayoptions)</code> - If you want to override configuration in the `app-update.yml`.

<a name="module_electron-updater.AppUpdater+channel"></a>
#### `appUpdater.channel()` (getter)
Get the current channel.

#### `appUpdater.channel(option)` (setter)
Define the channel which the Auto-Updater will follow (see [the auto-update with channels tutorial](/tutorials/release-using-channels.md). `option` is a `string` which define the channel (like `option='beta'`).
#### `appUpdater.channel` (getter and setter)
Define the channel which the Auto-Updater will follow (see [the auto-update with channels tutorial](tutorials/release-using-channels.md#release_using_channels)) using `appUpdater.channel = 'beta'` or get the current channel with `currentChannel = appUpdater.channel`.

<a name="module_electron-updater.AppUpdater+quitAndInstall"></a>
#### `appUpdater.quitAndInstall(isSilent, isForceRunAfter)`
Expand Down
12 changes: 3 additions & 9 deletions docs/tutorials/release-using-channels.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
> !!! This documentation is in "beta" and needed to be tested !!!
<a name="release_using_channels"></a>
# Release Using Channels / Auto-Updates With Channels

## Description
Expand Down Expand Up @@ -36,21 +35,16 @@ All you have to do to release using channels is to define the channel in the ver


### Your Application
All you need to do here is to define which channel the user will receive.
All you need to do here is to define which channel the user will receive with:

`autoUpdater.channel('beta')`
`autoUpdater.channel = 'beta'` (see [the documentation here](../auto-update.md#module_electron-updater.AppUpdater+channel))

The following versions will be distributed to users depending on the channel defined:
- "stable" or nothing: users will only get "stable" versions
- "beta": users will get "beta" and "stable" version
- "alpha": users will get "alpha", "beta" and "stable" version


### Advanced (optional)
todo:
- `allowDowngrade`
-

## How To Use It / Example
Imagine your application version is 1.0.1 (stable).

Expand Down

0 comments on commit 130311e

Please sign in to comment.