diff --git a/README.md b/README.md new file mode 100644 index 00000000..1c74b07a --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Floodgate + +[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +[![Build Status](https://ci.nukkitx.com/job/GeyserMC/job/Floodgate/job/development/badge/icon)](https://ci.nukkitx.com/job/GeyserMC/job/Floodgate/job/development/) +[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/) +[![HitCount](https://hits.dwyl.com/GeyserMC/Floodgate.svg)](http://hits.dwyl.com/GeyserMC/Floodgate) + +Hybrid mode plugin to allow for connections from [Geyser](https://github.com/GeyserMC/Geyser) to join online mode servers. + +Geyser is an open collaboration project by [CubeCraft Games](https://cubecraft.net). + +See the [Floodgate](https://github.com/GeyserMC/Geyser/wiki/Floodgate) page in the Geyser Wiki for more info about the what Floodgate is, how you setup Floodgate and known issues/caveats. + +See the [Floodgate wiki](https://github.com/GeyserMC/Floodgate/wiki) (currently work in progress) for a more in-depth look into Floodgate, how it works and the Floodgate API.