diff --git a/Readme.md b/Readme.md index e7dd1baf..22f213d9 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,4 @@ -ProtocolLib ![https://travis-ci.org/dmulloy2/ProtocolLib](https://travis-ci.org/dmulloy2/ProtocolLib.svg?branch=master) -=========== +# ProtocolLib [![Travis Status](https://travis-ci.org/dmulloy2/ProtocolLib.svg?branch=master)](https://travis-ci.org/dmulloy2/ProtocolLib) Certain tasks are impossible to perform with the standard Bukkit API, and may require working with and even modify Minecraft directly. A common technique is to modify incoming @@ -19,13 +18,11 @@ Currently maintained by dmulloy2 on behalf of [Spigot](http://www.spigotmc.org/) * [Downloads](http://ci.shadowvolt.com/job/ProtocolLib) * [JavaDoc](http://ci.shadowvolt.com/job/ProtocolLib/javadoc) -Compilation ----------- +### Compilation ProtocolLib is built with Maven and requires Spigot and SpigotAPI, which can be found [here](http://www.spigotmc.org/wiki/buildtools/). -A new API ---------- +### A new API __ProtocolLib__ attempts to solve this problem by providing a event API, much like Bukkit, that allows plugins to monitor, modify, or cancel packets sent and received. But, more importantly, @@ -56,7 +53,7 @@ You can also add ProtocolLib as a Maven dependency: com.comphenix.protocol ProtocolLib - 3.6.3-SNAPSHOT + 3.6.4-SNAPSHOT ```` @@ -148,8 +145,7 @@ try { } ```` -Compatibility ------------- +### Compatibility One of the main goals of this project was to achieve maximum compatibility with CraftBukkit. And the end result is quite flexible. Aside from netty package changes, it should be resilient against future changes. @@ -163,4 +159,4 @@ types. It's remarkably consistent across different versions. ### Incompatibility The following plugins (to be expanded) are not compatible with ProtocolLib: -* TagAPI +* TagAPI \ No newline at end of file