diff --git a/README.md b/README.md index bb131e8..5d93097 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ -# Bombermann +Bomberman +========= +A Bukkit plugin for Minecraft which adds Bomberman. + +https://www.spigotmc.org/resources/bomberman.77616/ + +## Building + +This project uses Maven and targets Java 21. + +To build the plugin JAR: + +```shell +mvn -DskipTests package +``` + +The shaded plugin JAR will be in: + +``` +target/bomberman-1.0.0.jar +``` + +To run the tests: + +```shell +mvn test +``` + +To copy the built JAR into a local test server, copy the JAR from `target/` into +your server's `plugins/` directory.