diff --git a/README.md b/README.md index ada9368..b149497 100644 --- a/README.md +++ b/README.md @@ -16,23 +16,27 @@ --> SLF4Bukkit === -SLF4J binding that uses Bukkit's plugin logging system. ---- -### Server Owners +SLF4Bukkit is an SLF4J binding that uses Bukkit's plugin logging system. + +### Server Administrators If you were linked here by documentation for a plugin that you're using on your Bukkit/Spigot server, [go here](http://rjenkinsjr.github.io/slf4bukkit) to learn what configuration options you have available (and please ask the plugin developer to fix their links!). ### Plugin Developers If you wish to use [SLF4J](http://slf4j.org) in your Bukkit plugin, or if your plugin has a dependency on a library that uses SLF4J: ++ Reference the [rjenkinsjr Maven2 Repository](https://github.com/rjenkinsjr/maven2) in your POM. + [Shade](https://maven.apache.org/plugins/maven-shade-plugin/usage.html) SLF4Bukkit into your plugin project: ```xml info.ronjenkins slf4bukkit - 0.1.1 + 0.1.2 ``` + (Optional) Add your desired default configuration values to your plugin's built-in [config.yml](http://rjenkinsjr.github.io/slf4bukkit) file. For more details, see the Javadocs for the [BukkitPluginLoggerAdapter](http://rjenkinsjr.github.io/slf4bukkit/apidocs/org/slf4j/impl/BukkitPluginLoggerAdapter.html) class. -+ (Optional) Use the [SLF4J API](http://www.slf4j.org/api/org/slf4j/Logger.html) in your code. Note that SLF4Bukkit does not support markers. ++ (Optional) Use the [SLF4J API](http://www.slf4j.org/api/org/slf4j/Logger.html) in your code. + + SLF4Bukkit supports only [Bukkit formatting markers](http://rjenkinsjr.github.io/slf4bukkit/apidocs/info/ronjenkins/slf4bukkit/BukkitColorMarker.html), which format the entire message and associated throwable (if any). All other markers are discarded. + + In addition to using the Bukkit formatting markers, you can use Bukkit's `ChatColor` values to further format your message. + + SLF4Bukkit issues `ChatColor.RESET` after every log message, so you don't have to worry about resetting after each message. diff --git a/pom.xml b/pom.xml index de082c9..f1dfde3 100644 --- a/pom.xml +++ b/pom.xml @@ -15,12 +15,11 @@ You should have received a copy of the GNU General Public License along with this program. If not, see . --> - + 4.0.0 info.ronjenkins slf4bukkit - 0.1.2-SNAPSHOT + 0.1.2 SLF4Bukkit ${project.name} is an SLF4J binding that uses Bukkit's plugin logging system. http://rjenkinsjr.github.io/slf4bukkit @@ -42,6 +41,7 @@ scm:git:git://github.com/rjenkinsjr/slf4bukkit.git scm:git:git@github.com:rjenkinsjr/slf4bukkit.git https://github.com/rjenkinsjr/slf4bukkit + 0.1.2