Skirda/SkirdaElectronLauncher
4
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

Updated Auto Updates (markdown)

Daniel Scalzi 2018-08-16 01:21:19 -04:00
parent ed618aff87
commit 4cabe269a4
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
Auto-Updates.md

@ -8,3 +8,34 @@
<p align="center"><em>Get notified when the update is ready and install at your convenience.</em></p> <p align="center"><em>Get notified when the update is ready and install at your convenience.</em></p>
## How the Auto-Updater Works ## How the Auto-Updater Works
The launcher automatically checks for new updates on startup and every five minutes thereafter. You can manually check for updates using the **Check for Updates** button on the update management tab in settings.
When the launcher find a new update, it is downloaded in the background. You will be notified when the update is ready to install. See the above image for details on this.
### Types of Releases
The launcher has two types of releases, Stable Releases (**Releases**) and **Pre-Releases**.
* **Releases** are updates which have been fully tested and are ready for general consumption.
* **Pre-Releases** include new features which may have not been fully tested or integrated. They are considered to be experimental.
#### How Pre-Releases Work
By default, the auto-updater only downloads releases. The auto-updater only looks for pre-releases when one of the following is true.
* You are currently running a pre-release build.
* You have **allow prerelease updates** enabled under Launcher Settings.
All alpha and beta builds are classified as pre-releases, therefore users already using these versions automatically get the latest pre-releases as soon as they are available. All users are upgraded to the latest stable release as soon as it is available. From that point onward, if you wish to receive pre-releases, you will need to enable the **allow prerelease updates** settings option. This can be found on the launcher tab.
<img src="https://user-images.githubusercontent.com/9703873/44085748-6d43bc1c-9f88-11e8-8106-593a5e2bd529.png" height="75%" width="75%">
*See also: [Beta 1 Release Notes](https://github.com/WesterosCraftCode/ElectronLauncher/releases/tag/v1.0.0-beta.1)*
 
If you enjoy testing bleeding-edge updates, consider enabling this option. The more testers we have, the quicker we can push out full releases.
---
*Auto-Updater finalized in [Alpha 18](https://github.com/WesterosCraftCode/ElectronLauncher/releases/tag/v0.0.1-alpha.18).*