Update Documentation

bundabrg · Aug 21, 2020 · 79f8e86 · 79f8e86
1 parent 3f2fce9
commit 79f8e86
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -22,8 +22,35 @@
 
 ---
 
-GeyserReversion is a Geyser Plugin that provides multiversion support for Geyser.
+GeyserReversion is a Geyser Plugin that provides protocol level support for MultiVersion in Geyser and will eventually
+allow any supported version to connect to any supported Geyser.
 
 ## Features
 
-* Coming
+* Minecraft Educational Edition Support
+* Multiversion Support - As more versions of an edition become available they can be added
+
+## Client Versions Supported
+* Minecraft Education v1.12.31
+* Minecraft Bedrock v1.16.2
+
+## Server Versions Support
+* Geyser Bedrock v1.16.2
+
+## Quick Start
+
+1. Make sure you are running a build of Geyser that supports native plugins. You can find a prebuilt one [here](https://github.com/bundabrg/Geyser/releases).
+
+2. Down the latest [GeyserReversion](https://github.com/bundabrg/GeyserReversion/releases) and place it inside your Geyser plugins folder. Note this is
+a folder 'plugins' underneath your Geyser folder. If you are running a plugin version of Geyser (Spigot/Bungeecord/Velocity)  then
+make sure to place it inside the `plugins/Geyser/plugins` folder. Standalone verison of Geyser will be a `plugins` folder
+where your Geyser.jar file is located.
+
+3. Start Geyser. It should show some indication that GeyserReversion is running. For example:
+
+```
+[11:08:37 INFO] {GeyserReversion} EducationServer listening on /0.0.0.0:19133
+[11:08:37 DEBUG] {GeyserReversion} Registered Translator: Translator_v390ee_to_v408be
+```
+
+
diff --git a/docs/config.md b/docs/config.md
@@ -0,0 +1,15 @@
+## Sample Configuration File
+
+```yaml
+# Edition supported. One of [bedrock, education]. Default: bedrock
+edition: education
+
+# Don't touch
+version: 1
+```
+
+## Configuration
+
+### edition
+Set the edition the server will listen for. This can be either `bedrock` or `education`. As both editions
+are not compatible they cannot listen on the same port.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -4,7 +4,7 @@ Here are some ways that you can help contribute to this project.
 
 ## New ideas or Bug Reports
 
-Need something? Found a bug? Or just have a brilliant idea? Head to the [Issues](https://github.com/Bundabrg/EduSupport/issues) and create new one.
+Need something? Found a bug? Or just have a brilliant idea? Head to the [Issues](https://github.com/Bundabrg/GeyserReversion/issues) and create new one.
 
 ## Contributing Code
 
@@ -13,8 +13,8 @@ If you know Java then take a look at open issues and create a pull request.
 Do the following to build the code:
 
 ```shell
-git clone https://github.com/Bundabrg/EduSupport
-cd EduSupport
+git clone https://github.com/Bundabrg/GeyserReversion
+cd GeyserReversion
 mvn clean package
 ```
 

diff --git a/docs/img/title.png b/docs/img/title.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,34 @@
 ![Logo](img/title.png)
 
-## What is EduSupport?
-
-EduSupport is a GeyserMC plugin that provides protocol support for Minecraft Educational Edition. This allows Minecraft Educational
-users to be able to log into a Java server.
+GeyserReversion is a Geyser Plugin that provides protocol level support for MultiVersion in Geyser and will eventually
+allow any supported version to connect to any supported Geyser.
 
 ## Features
 
-* Coming
+* Minecraft Educational Edition Support
+* Multiversion Support - As more versions of an edition become available they can be added
+
+## Client Versions Supported
+* Minecraft Education v1.12.31
+* Minecraft Bedrock v1.16.2
+
+## Server Versions Support
+* Geyser Bedrock v1.16.2
+
+## Quick Start
+
+1. Make sure you are running a build of Geyser that supports native plugins. You can find a prebuilt one [here](https://github.com/bundabrg/Geyser/releases).
+
+2. Down the latest [GeyserReversion](https://github.com/bundabrg/GeyserReversion/releases) and place it inside your Geyser plugins folder. Note this is
+a folder 'plugins' underneath your Geyser folder. If you are running a plugin version of Geyser (Spigot/Bungeecord/Velocity)  then
+make sure to place it inside the `plugins/Geyser/plugins` folder. Standalone verison of Geyser will be a `plugins` folder
+where your Geyser.jar file is located.
+
+3. Start Geyser. It should show some indication that GeyserReversion is running. For example:
 
-## Quickstart
+```
+[11:08:37 INFO] {GeyserReversion} EducationServer listening on /0.0.0.0:19133
+[11:08:37 DEBUG] {GeyserReversion} Registered Translator: Translator_v390ee_to_v408be
+```
 
-* Coming
+ 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,4 +75,5 @@ plugins:
 
 nav:
   - Introduction: index.md
+  - Configuration: config.md
   - Contributing: contributing.md