Create README.md

This commit is contained in:
Jan Holcak 2016-08-11 17:45:38 +02:00 committed by GitHub
parent 66b1381cd2
commit 294a4c1040

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# BetterAlias
"Smart" alias system for Bukkit commands
Links:
======
- [Bukkit](https://dev.bukkit.org/bukkit-plugins/betteralias/)
Build
=====
1. git clone https://github.com/Ne0nx3r0/BetterAlias.git
2. cd BetterAlias
3. mvn install
4. cp target/BetterAlias*.jar {$server_dir}/plugins/BetterAlias.jar
5. run server
Installation
============
1. Add BetterAlias.jar to your plugins directory
2. Once loaded an aliases.yml file will be created
3. Customize the file and use /bareload to enable the changes.
4. Use the examples inside aliases.yml to setup aliases for everyone to use! (or add a custom permission node for the command)