Update README.md

README.md

@@ -1 +1,24 @@
-# MechMaintenanceByCost
+# MechMaintenanceByCost
+BattleTech mod (using BTML) that changes your maintenance cost of your mechs, from a flat sum for all mechs, to a cost specific to the cost of the mech chassis.
+
+## Requirements
+** Warning: Uses the experimental BTML mod loader that might change, come here again to check for updates **
+
+* install [BattleTechModLoader](https://github.com/Mpstark/BattleTechModLoader/releases) using the [instructions here](https://github.com/Mpstark/BattleTechModLoader)
+
+## Features
+- Your Monthly mech cost now depend on the chassis.
+
+## Download
+
+Downloads can be found on [github](https://github.com/Morphyum/MechMaintenanceByCost/releases).
+
+## Settings
+Setting | Type | Default | Description
+--- | --- | --- | ---
+PercentageOfMechCost | float | default 0.003 | The percentage of the chassis cost you have to pay monthly. 1 = 100% / 0 = 0%
+
+## Install
+- After installing BTML, put  everything into \BATTLETECH\Mods\ folder.
+- If you want a different percentage set it in the settings.json.
+- Start the game.