Add README

Author: Raidriar796

README.md

@@ -0,0 +1,13 @@
+# FastSync
+
+A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that improves compression speed for sync messages.
+
+Sync messages by default use lz4 with the high compression mode. This mod simply disables the high compression mode, resulting in significantly faster compression with a slight increase in outbound traffic.
+
+## Requirements
+- [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader)
+
+## Installation
+1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader).
+2. Place [FastSync.dll](https://github.com/Raidriar796/FastSync/releases/latest/download/FastSync.dll) into your `rml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install. You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create the folder for you.
+3. Start the game. If you want to verify that the mod is working you can check your Resonite logs.