-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README with download instructions
- Loading branch information
Showing
1 changed file
with
24 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' | ||
``` |