diff --git a/README.md b/README.md index c10e506..99534e7 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,53 @@ [![Build Status](https://ci.codemc.org/buildStatus/icon?job=CodeMC/WorldEditWrapper)](https://ci.codemc.org/view/Author/job/CodeMC/job/WorldEditWrapper/) A wrapper for the WorldGuard API that allows plugins to support both v6 and v7 APIs. + +## Maven dependency +How to include WorldEditWrapper into your maven project: + +```xml + + + codemc-repo + https://repo.codemc.org/repository/maven-public/ + + + + + + org.codemc.worldguardwrapper + worldguardwrapper + 1.0.0-SNAPSHOT + + +``` + +Remember to include/relocate the library into your final jar, example: + +```xml + + + + org.apache.maven.plugins + maven-shade-plugin + 3.1.1 + + + package + + shade + + + + + + + org.codemc.worldguardwrapper + YOUR.PLUGIN.PACKAGE.libs.worldguardwrapper + + + + + + +```