diff --git a/README.md b/README.md index e69de29..b90febf 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,47 @@ +# MelooonCensor + +A simple censor plugin for Bukkit/CraftBukkit. + +## Commands + +### /censor add (censor|ignore) `word` + +Adds a word to the censored/ignored word list. + +### /censor remove (censor|ignore) `word` + +Removes a word from the censored/ignored word list. + +### /censor list [censor|ignore] + +Lists all the words in either the censored/ignored lists, or both (if none is specified). + +## Permissions + +#### meloooncensor.add.censor + +Permission to run `/censor add censor` + +#### meloooncensor.add.ignore + +Permission to run `/censor add ignore` + +#### meloooncensor.remove.censor + +Permission to run `/censor remove censor` + +#### meloooncensor.remove.ignore + +Permission to run `/censor remove ignore` + +#### meloooncensor.list.censor + +Permission to run `/censor list censor` + +#### meloooncensor.list.ignore + +Permission to run `/censor list censor` + +## License + +This repository and code is made available under the [MIT License](./LICENSE.md). \ No newline at end of file