From 5a57996e6e14de38c14420c7863add84975e3cfc Mon Sep 17 00:00:00 2001 From: Redned Date: Mon, 8 Jul 2019 13:04:39 -0500 Subject: [PATCH] Create README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..c5322e1a3 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Geyser +A bridge between Minecraft: Java Edition and Minecraft: Bedrock edition, breaking the gap from those wanting to play together. + +## What is Geyser? +Geyser is a (heavy work in progress) connector (or proxy), bridging the gap between Minecraft: Bedrock Edition and Minecraft: Java Edition servers. +The ultimate goal for this project is to allow those to join Minecraft: Java Edition servers using the Bedrock Edition. + +### Please note, this project is still a HEAVY work in progress and probably won't be complete any time soon. + +If you're interested in development, please join our Discord server: +https://discord.gg/cnb7wch + +## Compiling +Clone the repo to your computer, and run `mvn clean install`. + +## Contributing +As a project that is still nowhere near completion, any contributions are appreciated. Please feel free to reach out to us on Discord if +you're interested in helping this project come along.