From 9f242bb82f92345eaa01583ba7bf204877107a58 Mon Sep 17 00:00:00 2001
From: Kastle <26531652+Kas-tle@users.noreply.github.com>
Date: Tue, 6 Jul 2021 23:25:00 -0700
Subject: [PATCH] Create README.md

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e72acb8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Paradisu Plugin [![Java CI with Maven](https://github.com/SNW-MC/SuperNintendoWorldPlugin/workflows/Java%20CI%20with%20Maven/badge.svg)](https://github.com/SNW-MC/SuperNintendoWorldPlugin/actions?query=workflow%3A%22Java+CI+with+Maven%22) [![GitHub release](https://img.shields.io/github/release/SNW-MC/SuperNintendoWorldPlugin.svg)](https://GitHub.com/SNW-MC/SuperNintendoWorldPlugin/releases/) [![Discord](https://img.shields.io/discord/591914197219016707.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/gQcu2XYd2K)
+
+The official plugin for the Paradisu server. The plugin aims to provide many essential Minecraft server utilities, as well as features specific to the Paradisu project. For more information about the Paradisu project, feel free to join the [Discord](https://discord.gg/gQcu2XYd2K)
+
+The plugin is currently in early development and is not recommended for use on custom servers. Furthermore, the plugin is heavily customized for use on Paradisu, so extensive modifications would likely be required for use elsewhere.
+
+### Downloading Latest Release
+A jar packaged version of the latest release can be downloaded from the latest passing action on the [Releases Page](https://github.com/SNW-MC/SuperNintendoWorldPlugin/releases/latest).
+
+### Compiling
+```
+git clone https://github.com/SNW-MC/SuperNintendoWorldPlugin
+cd SuperNintendoWorldPlugin
+mvn clean package
+```
+### Features
+* Spawn, warp, and teleportation system
+* Fly mode for non-creative players
+* Lists and obtain available custom models
+* Gamemode management system
+* Inventory management system
+* Limited item NBT editing
+* Obtain player skulls
+
+Contributions are welcomed & appreciated!