From b91b3f3b2b9c65d59d43ef93f4762bdf1ee4bf59 Mon Sep 17 00:00:00 2001
From: RaphiMC <50594595+RaphiMC@users.noreply.github.com>
Date: Wed, 4 Jan 2023 21:54:57 +0100
Subject: [PATCH] Updated README

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 47 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 8abedfd..2976083 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,10 @@
 # ViaProxy
-Standalone proxy which uses ViaVersion to translate between minecraft versions.
+Standalone proxy which uses ViaVersion to translate the protocol between minecraft versions.
+
+ViaProxy allows you to join to essentially any minecraft version server from a modern client.  
+To download the latest version, go to the [Releases section](#executable-jar-file) and download the latest version.  
+Using it is very simple, just run the jar file, and it will start an user interface where everything can be configured.  
+For a full user guide go to the [Usage for Players](#usage-for-players) section or the [Usage for Server Owners](#usage-for-server-owners) section.
 
 ## Supported Server versions
 - Classic (c0.0.15 - c0.30 including [CPE](https://wiki.vg/Classic_Protocol_Extension))
@@ -11,15 +16,51 @@ Standalone proxy which uses ViaVersion to translate between minecraft versions.
 
 ## Supported Client versions
 - Release (1.7.2 - 1.19.3)
-- April Fools (3D Shareware)
 
 ## Releases
+### Executable Jar File
+If you want the executable jar file you can download a stable release from [GitHub](https://github.com/RaphiMC/ViaProxy/releases/latest) or the latest version from this [Jenkins](https://build.lenni0451.net/job/ViaProxy/).
+
 ### Gradle/Maven
 To use ViaProxy with Gradle/Maven you can use this [Maven server](https://maven.lenni0451.net/#/releases/net/raphimc/ViaProxy) or [Jitpack](https://jitpack.io/#RaphiMC/ViaProxy).  
 You can also find instructions how to implement it into your build script there.
 
-### Jar File
-If you just want the latest jar file you can download it from this [Jenkins](https://build.lenni0451.net/job/ViaProxy/).
+## Usage for Players (GUI)
+![ViaProxy GUI](https://i.imgur.com/N2JCvEp.png)
+1. Download the latest version from the [Releases section](#executable-jar-file)
+2. Put the jar file into a folder (ViaProxy will generate config files and store some data there)
+3. Run the jar file
+4. Fill in the required fields like server address and version
+5. Click on "Start"
+6. Join with your minecraft client on the displayed address
+7. Have fun!
 
-## Usage
-TODO
+## Usage for Server owners (CLI)
+1. Download the latest version from the [Releases section](#executable-jar-file)
+2. Put the jar file into a folder (ViaProxy will generate config files and store some data there)
+3. Run the jar file (Using java -jar ViaProxy-whateverversion.jar --help)
+4. Look at the available config options and use those you need just like you would in the GUI
+5. Start the proxy using the start command and test whether it works (Join using the server's public address and the bind port you configured)
+6. Have fun!
+
+Here is an example command to allow players to join on yourserverip:25568 and connect to a beta 1.7.3 server running on port 25565:
+``java -jar ViaProxy-whateverversion.jar --bind_port 25568 --target_ip 127.0.0.1 --target_port 25565 --version b1.7-b1.7.3``
+
+## Advanced Usage
+### Online Mode
+If you want to join online mode servers you need to install the [OpenAuthMod](https://modrinth.com/mod/openauthmod) mod.
+When you have the mod installed and select "OpenAuthMod" as authentication type in the GUI / CLI.
+
+### Configuring the protocol translation
+To change the protocol translation settings/features you can look into the ViaProtocolHack folder.
+You will find 4 config files there:
+- viaversion.yml (ViaVersion)
+- config.yml (ViaBackwards)
+- viarewind.yml (ViaRewind)
+- vialegacy.yml (ViaLegacy)
+
+## Contact
+If you encounter any issues, please report them on the
+[issue tracker](https://github.com/RaphiMC/ViaProxy/issues).  
+If you just want to talk or need help using ViaProxy feel free to join my
+[Discord](https://discord.gg/dCzT9XHEWu).
\ No newline at end of file