From 1df015cd263af928048f05cbff4fbce699303585 Mon Sep 17 00:00:00 2001
From: MathieuG-P <40181755+Zagrios@users.noreply.github.com>
Date: Sun, 7 Aug 2022 15:41:55 +0200
Subject: [PATCH] init readme

---
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

diff --git a/README.md b/README.md
index e69de29b..6dfbede1 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,76 @@
+<p align="center">
+	<a href="https://github.com/RiskiVR/BSLegacyLauncher">
+		<img src="https://raw.githubusercontent.com/Zagrios/bs-manager/master/resources/readme/icon.svg" alt="logo" width="250px"/>
+	</a>
+	<h3 align="center" style="font-size: 28px">BSManager</h3>
+	<p align="center" style="width: 500px; margin: auto">Simple and fancy tools that alow you to download, manage and launch BeatSaber versions. And in the near future download and manage Mods and Maps.</p>
+</p>
+
+<p align="center">
+    <img src="https://github.com/Zagrios/bs-manager/blob/master/resources/readme/beat-running.png?raw=true" width="130"/>
+</p>
+
+<details open="open">
+	<summary>
+        <h2 style="display: inline-block">Table of Contents</h2>
+    </summary>
+	<ol>
+		<li>
+			<a href="#about-the-project">About The Project</a>
+			<ul><li><a href="#built-with">Built With</a></li></ul>
+		</li>
+		<li><a href="#how-to-use">How To Use</a></li>
+		<li><a href="#having-problems">Having problems?</a></li>
+		<li><a href="#contact">Contact</a></li>
+		<li><a href="#acknowledgements">Acknowledgements</a></li>
+	</ol>
+</details>
+
+<h2 id="about-the-project">About The Project</h2>
+<p>
+Have you ever wanted to switch between multiple BeatSaber version? To have a specific version for you and your friends, or for personal use and Streaming use? Have you ever wanted to manage easily <b>Maps</b> and <b>Mods</b> between versions? All of that in one place? <b>Then this program is made for you!</b>
+<br/><br/>
+BSManager is designed to download any BeatSaber version from Steam's depots, and launch it within the same program!<br>
+- You can install as many versions as you want, customize them to quickly differentiate them, clone them to separate the additional contents of the same version!<br>
+- You can clone and launch your Steam version from the program!<br/><br/>
+<b>In the near future</b><br/>
+- You can Create a master Maps folder and link it across all versions!<br/>
+- You can download Maps with "OneClick"!<br/>
+- You can download and manage Mods for each versions!<br/>
+- And even more!
+</p>
+<h3 id="built-with" style="margin:0">Built With</h3>
+<ul>
+	<li>
+		<a href="https://github.com/electron-react-boilerplate/electron-react-boilerplate">Electron React Boilerplate</a>
+	</li>
+	<li>
+		<a href="https://github.com/SteamRE/DepotDownloader">DepotDownloader</a>
+	</li>
+</ul>
+
+<h2 id="how-to-use">How To Use</h2>
+<ul>
+	<li>
+		Download the latest release from <a href="https://github.com/Zagrios/bs-manager/releases">Releases</a>.
+	</li>
+	<li>Execute the installer and BSManager will start itself.</li>
+	<li>Once its done if you want to download a version, select a version and download it!</li>
+	<li>From the version page you can choose launch options, launch the version, and more from the dropdown menu!</li>
+</ul>
+
+<h2 id="having-problems">Having problems?</h2>
+<p>
+See the <a href="https://github.com/Zagrios/bs-manager/issues">open issues</a> for a list of known issues, from there you can create a new issue for the problem you have!  
+Otherwise you can add on to existing issues if one matches what you're encountering.
+</p>
+<h2 id="acknowledgements">Acknowledgement</h2>
+<ul>
+	<li><a href="https://github.com/Zagrios">Zagrios</a> - Founder, Lead Developer & Project Lead</li>
+	<li><a href="https://github.com/Iluhadesu">Iluhadesu</a> - Custom DepotDownloader Developer</li>
+	<li><a href="https://github.com/GaetanGrd">Gaëtan Gerard</a> - Main Alpha Tester</li>
+</ul>
+<p align="center">
+	<img src="https://github.com/Zagrios/bs-manager/blob/master/resources/readme/beat-conflict.png?raw=true" width="130"/>
+</p>
+