Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ISSUE-216 Augment README with dependency management guidance #217

Merged
merged 1 commit into from
Jul 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,43 @@ If you're using the Log4j 2, Simple Logging Facade for Java (SLF4J), or Logback
* For more about about Splunk in general, see
[Splunk>Docs](http://docs.splunk.com/Documentation/Splunk).

## Dependency Management

The `splunk-library-javalogging` artifact can be accessed via Splunk's managed Maven repoitory.

### Apache Maven

First define the repository as follows

```xml
...
<repositories>
<repository>
<id>splunk-artifactory</id>
<name>Splunk Releases</name>
<url>https://splunk.jfrog.io/splunk/ext-releases-local</url>
</repository>
</repositories>
...
```

... then reference the dependency as follows

```xml
...
<dependencies>
<dependency>
<groupId>com.splunk.logging</groupId>
<artifactId>splunk-library-javalogging</artifactId>
<version>${latest.version}</version>
</dependency>
...
</dependencies>
...
```

The above can be adapted to suit Other dependency management implementations as necessary.

## License

Splunk logging for Java is licensed under the Apache License 2.0.
Expand Down