chore: Auto updating (#16)

* [chore] adding electron-updater dependency

* [feat] adding auto-updating mechanism

* [chore] setting package version to v0.8.0

* [fix] restoring original repo URL

* [docs] adding some documentation about publishing new releases

* [chore] adding publish:windows command

* [docs] updating publish instructions with new publish command

* [chore] adding publish:linux command

* [docs] updating publish instructions

* --updatevp, and option to disable auto updates

If you want you can set "autoupdates" to false in your config, no GUI
tools to do this yet. For the CLI auto updates is off by default and
you'll have to use --updatevp.

I also removed the snap package, tho whether this stays as a change is
still to be discussed.

And with the new option I updated the help menu, the man page and
everything along else that needs it.

* removed "soon" parts of README for auto-updates

* [feat] adding French translation for cli.help.updatevp key

* confirmation for restarting the app

Now instead of automatically updating and restarting the app, which may
be slightly confusing to some users, (the app opens then closes and then
opens), it now asks whether you want to restart and open the new
version. If you say no, instead next time you launch it, it'll be on the
new version.

If you want to completely disable updates you can disable it in the
viper.json file...

* [feat] adding French translation for gui.update.available key

* added configuration instruction in README

Co-authored-by: 0neGal <mail@0negal.com>

1 files changed, 8 insertions, 3 deletions

diff --git a/README.md b/README.md
index 2ee180d..3a1c408 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@ Additionally, if you really want to, you can build Viper with `npm run build` an
 
 Downloads are available on the [releases page](https://github.com/0neGal/viper/releases/latest). 
 
-Please note that some versions will (*[soon™](https://github.com/0neGal/viper/tree/auto-updates)*) update themselves automatically when a new release is available (just like Origin or Steam) and some will NOT, so choose it accordingly. Only the AppImage and Windows Setup/Installer can auto-update.
+Please note that some versions will update themselves automatically when a new release is available (just like Origin or Steam) and some will NOT, so choose it accordingly. Only the AppImage and Windows Setup/Installer can auto-update.
 
 **Windows:** `Viper Setup [x.y.z].exe` (auto-updates, and is recommanded), `Viper [x.y.z].exe` (single executable, no fuss)
 
@@ -43,11 +43,17 @@ Currently Viper is capable of:
  * Updating/Installing Northstar
  * Launching Vanilla and or Northstar
  * Manage Mods (Soon, see [**mod-support**](https://github.com/0neGal/viper/tree/mod-support) branch)
- * Auto-Update itself (Soon, see [**auto-updater**](https://github.com/0neGal/viper/tree/auto-updates) branch)
+ * Auto-Update itself 
  * Be pretty!
 
 Besides this I've been considering adding some easy to use VPK modding tools so everybody can have fun with VPK modding even if you don't know how to do it the traditional way. However that is not at the top of the todo list right now.
 
+## Configuration
+
+Almost all configuration takes place inside the UI, and almost no configuration isn't either handled their or automatically handled, the only option that isn't configured in the GUI is disabling auto-updates, by default updates are handled automatically, when you launch the application it'll update, ask you if you want to restart, if not it'll continue with the old version until you restart, however you can disable this entirely by settings `"autoupdates": true` to false in your `viper.json`
+
+Your configuration file will be found in `%APPDATA%\viper.json` on Windows, and inside either `~/.config` or through your environment variables (`$XDG_CONFIG_HOME`) on Linux, the latter has priority.
+
 ## Sidenote
 
 Given that we already have so many Northstar updaters and launchers I urge people to instead of creating new launchers unless there's a very specific reason, just make a pull request on one of the existing, otherwise we'll continue to have new ones.
@@ -63,7 +69,6 @@ Some of the existing launchers are listed below:
  * [laundmo's updater](https://github.com/laundmo/northstar-updater) - another CLI only updater
  * [Juicy's mod manager](https://github.com/BigSpice/NorthStar-Mod-Manager-Ext-1) - an updater and manager for mods, most feature rich
 
-
 ## Credits
 
 All credits for logos go to Imply#9781.