Merge branch 'main' of 0neGal/viper into mod-support

1 files changed, 36 insertions, 3 deletions

diff --git a/README.md b/README.md
index 8cf0228..3a1c408 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 Viper is a launcher and updater for [Northstar](https://github.com/R2Northstar/Northstar), and not much more than that.
 
 <p align="center">
-  <img src="preview.png">
+	<img src="assets/preview.png">
 </p>
 
 ## How to?
@@ -24,18 +24,51 @@ This'll launch it with the Electron build installed by `npm`.
 
 Additionally, if you really want to, you can build Viper with `npm run build` and it'll then build the Windows installer and AppImage, however the whole build process and everything related to it is still being worked on which is why we don't have official releases yet.
 
+## Install
+
+(this will be relevant once we start to publish releases)
+
+Downloads are available on the [releases page](https://github.com/0neGal/viper/releases/latest). 
+
+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)
+
+**Linux:** `.AppImage` (auto-updates), `.deb`, `.rpm`, `.snap`, `.tar.gz`
+
 ## What can it do specifically?
 
 Currently Viper is capable of:
 
  * Updating/Installing Northstar
  * Launching Vanilla and or Northstar
- * Manage Mods (Soon, see **mod-support** branch)
- * Auto-Update itself (Soon, see **auto-updater** branch)
+ * Manage Mods (Soon, see [**mod-support**](https://github.com/0neGal/viper/tree/mod-support) 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.
+
+<p align="center">
+	Relevant xkcd:<br>
+	<img src="assets/xkcd.png">
+</p>
+
+Some of the existing launchers are listed below:
+ * Viper - A launcher with an easy to use GUI and CLI albeit missing some features
+ * [Ronin](https://github.com/MindSwipe/ronin) - a CLI only updater
+ * [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.