Skip to content

Commit

Permalink
+ elf4j version bump
Browse files Browse the repository at this point in the history
+ tinylog version bump
  • Loading branch information
q3769 committed May 14, 2023
1 parent fc9ead1 commit 4a1884a
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-tinylog.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.elf4j%22%20AND%20a:%22elf4j-tinylog%22)

# elf4j-tinylog

An adapter to use [tinylog](https://tinylog.org/v2/) as service provider and runtime log engine for
Expand All @@ -17,18 +19,16 @@ Java 8+

[![Maven Central](https://img.shields.io/maven-central/v/io.github.elf4j/elf4j-tinylog.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.github.elf4j%22%20AND%20a:%22elf4j-tinylog%22)

In Maven or other build tools alike, install [ELF4J API](https://github.com/elf4j/elf4j) as compile-scope dependency;
and this provider as runtime-scope dependency.

## Use it...

If you are using the [ELF4J API](https://github.com/elf4j/elf4j) for logging, and wish to select or
change to use tinylog as the run-time log engine, then simply pack this binding JAR in the classpath when the
application deploys. No code change needed. At compile time, the client code is unaware of this run-time logging service
provider. With the ELF4J facade, opting for tinylog as the logging implementation is a deployment-time decision.

The usual [tinylog configuration](https://tinylog.org/v2/configuration/) applies.

With Maven, in addition to use compile-scope on the [ELF4J API](https://github.com/elf4j/elf4j) dependency, an end-user
application would use runtime-scope for this provider as a dependency:

```html

<dependency>
Expand All @@ -44,6 +44,8 @@ application would use runtime-scope for this provider as a dependency:
</dependency>
```

The usual [tinylog configuration](https://tinylog.org/v2/configuration/) applies.

Note: Only one logging provider such as this should be in effect at run-time. If multiple providers end up in the final
build of an application, somehow, then the `elf4j.logger.factory.fqcn` system property will have to be used to select
the desired provider. For example,
Expand Down

0 comments on commit 4a1884a

Please sign in to comment.