diff --git a/README.md b/README.md index b840b1d..53a9628 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # levelSync - levelSync + +levelSync is a spigot plugin which help you to synchronize minecraft vanilla experience between yours servers using MySQL. + +# Installation + +- Put the .jar file in your spigot (not bungeecord) plugin folder + +- restart your server to generate config file, then edit it + +- restart server, enjoy ! + +# Configuration + + + +```YAML +mysql: + # mysql server hostname or ip adress + host: "example.com" + # mysql socket + port: 3306 + username: "username" + password: "password" + # mysql database, you need to create it first + database: "minecraft" + # table name, automatically created by the plugin + table: "playerLevel" +```