Skip to content

Commit

Permalink
Updated README with download instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ekoutanov committed Oct 18, 2017
1 parent ac5c865 commit 37c41ce
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
<dependency>
<groupId>com.obsidiandynamics.log4jextras</groupId>
<artifactId>log4j-extras-module</artifactId>
<version>x.y.z</version>
<type>pom</type>
</dependency>
```

For Gradle:

```groovy
compile 'com.obsidiandynamics.log4jextras:log4j-extras-module:x.y.z'
```

0 comments on commit 37c41ce

Please sign in to comment.