From 37c41ce85dbb8c26c296f5272828b0e68f6ae5b8 Mon Sep 17 00:00:00 2001 From: Emil Koutanov Date: Wed, 18 Oct 2017 20:13:52 +1100 Subject: [PATCH] Updated README with download instructions --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 582fc2c..8c85f65 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ Log4J extras === +[ ![Download](https://api.bintray.com/packages/obsidiandynamics/log4j-extras/log4j-extras-json/images/download.svg) ](https://bintray.com/obsidiandynamics/log4j-extras/log4j-extras-json/_latestVersion) + Log4J addons/modules comprising: * [`log4j-extras-json`](https://github.com/obsidiandynamics/log4j-extras/tree/master/json) - JSON layout * [`log4j-extras-splunk`](https://github.com/obsidiandynamics/log4j-extras/tree/master/splunk) - Splunk HEC appender + +# Getting started +Select just the module(s) that you need from the list above. + +The builds are hosted on JCenter. (Maven users may need to add the JCenter repository to their POM.) Simply add the following snippet to your build file. Replace the version placeholder `x.y.z` in the snippet with the version shown on the Download badge at the top of this README, and `log4j-extras-module` with the name of the actual module you need. + +For Maven: + +```xml + + com.obsidiandynamics.log4jextras + log4j-extras-module + x.y.z + pom + +``` + +For Gradle: + +```groovy +compile 'com.obsidiandynamics.log4jextras:log4j-extras-module:x.y.z' +```