Merge branch 'master' of https://github.com/AriAlavi/rimlink

Author: AriAlavi

README.md

@@ -1,4 +1,9 @@
 # Rimlink
-Sync rimworld files with your friends to avoid desync in multiplayer. One person will host the sync and then others can sync to it. Only works for Windows 7/ Windows 10 computers.
+The purpose of this utility is to sync rimworld mods, updates, and config folders between a host and multiple users. This will help with reduce the frequency of desyncs when using the multiplayer mod. It only works for Windows as I do not have access to a Mac.
 
-Requires port forwarding on port 5002 or Hamachi in order to work for the host.
+In order to use:
+1. Port forward on port 5002 OR Make use of Hamachi (if making use of Hamachi, use Hamachi's IP and not your own)
+2. Put rimlink.exe in your Rimworld directory and run as admin
+3. If you generally host the Rimworld server, make sure you say (y)es when asked so
+4. After host has the rimlink tool running, then your friends can run the rimlink tool in the same way, but saying (n)o when asked if they host rimworld servers
+5. Rimlink will make sure your friend's files and folders are 100% exactly the same as yours. It will download and remove files as needed for that to happen