add: readme & gitignore
This commit is contained in:
parent
a6561de5be
commit
f9f74102d0
2 changed files with 19 additions and 0 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
||||||
|
target/
|
18
README.md
Normal file
18
README.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# Silencer
|
||||||
|
|
||||||
|
A mute system with only one job that is muting players.
|
||||||
|
It is designed to be as lightweight as possible, holding only a single class, and using no traditional database of any kind. Instead, it uses [Persistent Data Containers](https://docs.papermc.io/paper/dev/pdc) to store data.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
1. Maven
|
||||||
|
|
||||||
|
### Build
|
||||||
|
|
||||||
|
```
|
||||||
|
mvn package
|
||||||
|
```
|
||||||
|
|
||||||
|
The plugin will be in the newly-made target folder.
|
||||||
|
|
Loading…
Reference in a new issue