Add proper readme

This commit is contained in:
mathiascode 2019-12-17 17:39:28 +02:00
parent c6374021b6
commit d8fc0aaeb6
2 changed files with 23 additions and 3 deletions

3
.gitignore vendored
View File

@ -1,4 +1,5 @@
.settings/
bin/
target/
.classpath
.project
.project

View File

@ -1,3 +1,22 @@
# weapons
# Weapons
Source code for the Weapons plugin on the Kaboom server
Weapons is a Bukkit plugin that implements various weapons.
The plugin is created for the Kaboom server.
## Commands
| Command | Alias | Permission | Description |
| ------- | ----- | ---------- | ----------- |
|/weapons | /weapon | weapons.command | Gives you a weapon|
## Compiling
Use [Maven](https://maven.apache.org/) to compile the plugin.
```bash
mvn package
```
The generated .jar file is located in the target/ folder.
## License
[Unlicense](https://unlicense.org/)