Updated README

README.md

@@ -1,2 +1,99 @@
 # BetterPolus
-An Among Us mod that tweaks Polus a little bit (Vitals at Laboratory, Wifi at Dropship, re-routing of some Vents, ...) 
+An Among Us mod that tweaks Polus, allowing a more balanced experience.
+
+## Features
+- **Vitals** have been moved to **Laboratory**.
+- The **Reboot Wifi task** is now located in the **Dropship**.
+- The **Chart Course** task is now located in **Comms**.
+- The **Vents** near both Reactor Pods are **not linked to each other** anymore.
+   - The Vent on **top of Electrical** is linked to the Vent on **top of Security**.
+   - The Vent **outside of Laboratory** is linked to the Vent **inside Storage**.
+
+## Technology
+This mod has been created using **[Reactor Modding Framework](https://github.com/NuclearPowered/Reactor)**. The game is patched at runtime via **[Reactor BepInEx](https://github.com/NuclearPowered/BepInEx)** and no game file is actually altered.
+
+For the moment, this mod supports **Among Us v2020.12.9s** *(Steam version)*.
+
+## Installation
+For a better experience, every player in your lobby should download BetterPolus. You *can* play with people that don't have the mod installed but keep in mind that they won't see the same things as you (for example Vitals location).
+
+There are two ways to install the mod :
+- **All-in-one pack _(Easiest)_:** The easiest way to install BetterPolus.
+- **Custom install _(Advanced/Recommended)_:** Download and install everything by yourself.
+
+### All-in-one pack
+1. Download the pack for your game version in the **[Releases section](#releases)** below.
+2. Extract the content of the zip file into your game folder (**`Steam/steamapps/common/Among Us`**).
+3. Run the game from Steam.
+
+### Custom install
+1. Install Reactor BepInEx by following **[these instructions](https://docs.reactor.gg/docs/basic/install_bepinex/)**.
+2. Install Reactor by following **[these instructions](https://docs.reactor.gg/docs/basic/install_reactor)**.
+3. Download the **dll file** for your game version in the **[Releases section](#releases)** below.
+4. Copy the dll file into **`Among Us/BepInEx/plugins`**.
+5. (Optional) If you want to play on official servers, you must do the following :
+    - Open **`Among us/BepInEx/config/gg.reactor.api.cfg`** with a text editor.
+    - Find the line `Modded handshake = true` and change it to `Modded handshake = false`.
+    - Save and close your editor.
+
+ ## Releases
+ | Among Us Version | Mod Version | All-in-one pack | DLL file |
+ | ---------------- | ----------- | :-------------: | :------: |
+ | v2020.12.9s      | Ver. 1.0.0  | **[Download]()** | **[Download]()** |
+
+ ### Changelog
+ <details>
+ <summary>Version 1.0.0</summary>
+ <ul>
+    <li>Vitals have been moved to Laboratory.</li>
+    <li>The Reboot Wifi task is now located in the Dropship.</li>
+    <li>The Chart Course task is now located in Comms.</li>
+    <li>The Vents near both Reactor Pods are not linked to each other anymore.
+        <ul>
+            <li>The Vent on top of Electrical is linked to the Vent on top of Security.</li>
+            <li>The Vent outside of Laboratory is linked to the Vent inside Storage.</li>
+        </ul>
+    </li>
+ </ul>
+ </details>   
+
+ ## Uninstall
+ ### Uninstall BetterPolus
+ To uninstall BetterPolus, simply delete the BetterPolus dll file from **`Among Us/BepInEx/plugins`**.
+
+ ### Uninstall Reactor/BepInEx
+ To completely uninstall everything, either uninstall/reinstall the game from steam or remove the following files and directories :
+ ```
+-- BepInEx/
+-- mono/
+-- changelog.txt
+-- doorstop_config.ini
+-- steam_appid.txt
+-- winhttp.dll
+```
+
+## Q&A
+**How do I know if BetterPolus is correctly installed?**
+
+Just check that there is a line saying that BetterPolus has been loaded in the top left of the main menu.
+
+**Does this works with (Better-)CrewLink (Proximity Chat)?**
+
+Of course!
+
+**Do I risk anything if I play on official Servers?**
+
+There is currently no permaban system for the game so it's safe to play on official servers. However, I still recommend you to host your own custom server to be safe. For more information, you can check these repositories :
+- **[Impostor/Impostor](https://github.com/Impostor/Impostor):** A custom server that allows you to create your own plugins.
+- **[NuclearPowered/Impostor](https://github.com/NuclearPowered/Impostor):** Impostor but maintained by the team behind Reactor. <ins>Use this if you want to play with plugins that need Reactor's Custom RPC API or Modded Handshake.</ins>
+
+**Can you use BetterPolus with Woodi's Sheriff Mod?**
+
+Unfortunately, Reactor doesn't support Woodi's Sheriff Mod at the time being.
+
+**How can I get started at Among Us Modding?**
+
+Look at the **[Reactor documentation](https://docs.reactor.gg/)** to get started, and join **[Reactor's Discord](https://discord.gg/Zcmsb9UGuq)** to get more help from the community.
+
+## Licensing
+BetterPolus is licenced under the **[MIT License](LICENSE)**. While you don't have to credit me if you use or modify this mod, it's greatly appreciated!