Update readme

This commit is contained in:
Luck 2016-07-26 03:39:56 +01:00
parent 0ecd899ec5
commit cba12c3e78

View File

@ -1,6 +1,10 @@
# LuckPerms # LuckPerms [![Build Status](https://ci.lucko.me/job/LuckPerms/badge/icon)](https://ci.lucko.me/job/LuckPerms/)
A permissions implementation for Bukkit/BungeeCord. A permissions implementation for Bukkit/BungeeCord.
## Links
* **Development Builds** - <https://ci.lucko.me/job/LuckPerms/>
* **Javadocs** - <https://ci.lucko.me/job/LuckPerms/javadoc/>
## Features ## Features
* **Group inheritance** - users can be members of multiple groups, groups can inherit other groups * **Group inheritance** - users can be members of multiple groups, groups can inherit other groups
* **Temporary permissions** - users/groups can be given permissions that expire after a given time * **Temporary permissions** - users/groups can be given permissions that expire after a given time
@ -66,6 +70,24 @@ depend: [LuckPerms]
``` ```
All of the available methods can be seen in the various interfaces in the `luckperms-api` module. All of the available methods can be seen in the various interfaces in the `luckperms-api` module.
You can add LuckPerms as a Maven dependency by adding the following to your projects `pom.xml`.
````xml
<repositories>
<repository>
<id>luck-repo</id>
<url>https://ci.lucko.me/plugin/repository/everything/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>me.lucko.luckperms</groupId>
<artifactId>luckperms-api</artifactId>
<version>1.4</version>
</dependency>
</dependencies>
````
## Commands ## Commands
Command usage is printed to the console/chat whenever invalid arguments are provided. Simply typing /perms will list all commands a user has permission to use. Command usage is printed to the console/chat whenever invalid arguments are provided. Simply typing /perms will list all commands a user has permission to use.