From 5039a05055dbd6b6a35cc5b1711e49f9f05959d2 Mon Sep 17 00:00:00 2001 From: Luck Date: Fri, 27 Jan 2017 20:37:27 +0000 Subject: [PATCH] Update readme --- README.md | 42 ++++++++++++++++++++++++++---------------- pom.xml | 2 +- 2 files changed, 27 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 7199effee..4c5ad900e 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,44 @@ ![alt text](https://i.imgur.com/7TwJZ5e.png "Banner") # LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/) -An advanced permissions implementation for Bukkit/Spigot, BungeeCord and Sponge. - -## Links -* **Development Builds** - -* **Javadocs** - -* **Wiki** - - -## Description LuckPerms is an advanced permissions implementation aiming to be a fast, reliable and flexible alternative to existing permission plugins. The project's main goals are centered around high performance and a wide feature set, filling the gaps of functionality and building upon existing features found in other plugins. LuckPerms also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options. -See the charts below for a partial list of features & comparison with other providers. +[See the charts below](https://github.com/lucko/LuckPerms#luckperms-vs-other-plugins) for a partial list of features & comparison with other providers. * [Spigot Plugin Release Page](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-system.28140/ "Spigot Plugin Page") * [Sponge Plugin Release Page](https://forums.spongepowered.org/t/luckperms-an-advanced-permissions-system/14274 "Sponge Plugin Page") +## Useful Links +* **Development Builds** - +* **Javadocs** - +* **Wiki** - + +## Building +LuckPerms uses Maven to handle dependencies. + +#### Requirements +* Maven 3.3.x (the older versions will not work.) +* Git + +#### Then run +```sh +git clone https://github.com/lucko/LuckPerms.git +mvn clean package +``` + +## License +LuckPerms is licensed under the permissive MIT license. Please see [`LICENSE.txt`](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) for more info. + ## LuckPerms vs Other Plugins ### Bukkit ![alt text](https://static.lucko.me/luckperms-compare-copy.png "Feature comparison") -_Features checked on 23rd Aug 2016. If you find any inaccuracies, please do let me know. I tried to be as fair as possible, and copy all major features from the respective plugin pages._ +###### _Features checked on 23rd Aug 2016. If you find any inaccuracies, please let me know._ ### Sponge ![alt text](https://static.lucko.me/luckperms-compare-sponge.png "Feature comparison") -_Features checked on 8th Oct 2016. If you find any inaccuracies, please do let me know. I tried to be as fair as possible, and copy all major features from the respective plugin pages._ +###### _Features checked on 8th Oct 2016. If you find any inaccuracies, please let me know._ -## License -LuckPerms is licensed under the permissive MIT license. See LICENSE.txt for more info. - -## Sponsor +## Thanks [![JProfiler](https://www.ej-technologies.com/images/product_banners/jprofiler_large.png)](http://www.ej-technologies.com/products/jprofiler/overview.html) -Thanks to ej-technologies for granting LuckPerms an open source licence to their [Java Profiling Software](http://www.ej-technologies.com/products/jprofiler/overview.html "Java Profiler"). +Thanks to ej-technologies for granting LuckPerms an open source licence to their [Java Profiling Software](http://www.ej-technologies.com/products/jprofiler/overview.html "Java Profiler"). \ No newline at end of file diff --git a/pom.xml b/pom.xml index 136bb04c8..5558ffca5 100644 --- a/pom.xml +++ b/pom.xml @@ -87,7 +87,7 @@ luck-repo - http://repo.lucko.me/ + https://repo.lucko.me/ vault-repo