README.md - logging-log4j-kotlin - Git at Google

 # [Apache Log4j 2 (Kotlin API)](http://logging.apache.org/log4j/2.x/)

 Log4j Kotlin API is a Kotlin logging facade based on Log4j 2. Log4j Kotlin API provides Log4j 2 as its
 default logging implementation, but this is not strictly required (e.g., this API can also be used with Logback
 or other Log4j 2 API provider implementations). Idiomatic Kotlin features are provided as an alternative to using
 the Log4j 2 Java API.

 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-api-kotlin.svg)](https://search.maven.org/artifact/org.apache.logging.log4j/log4j-api-kotlin)
 [![Build Status](https://ci-builds.apache.org/job/Logging/job/log4j-kotlin/job/master/lastBuild/badge/icon)](https://builds.apache.org/job/Logging/job/log4j-kotlin/job/master/)

 ## Pull Requests on Github

 By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted
 work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the
 Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are
 judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.

 ## Usage

 Gradle users can add the following dependencies to their `build.gradle` file:

 TODO

 ```groovy
 compile "org.apache.logging.log4j:log4j-api-kotlin:1.2.0"
 compile "org.apache.logging.log4j:log4j-api:2.17.0"
 compile "org.apache.logging.log4j:log4j-core:2.17.0"
 ```

 ## Documentation

 [//]: # "The Log4j Kotlin API is documented [in the Log4j 2 manual](https://logging.apache.org/log4j/2.x/manual/kotlin-api.html)"
 [//]: # "and in the [KDocs](https://logging.apache.org/log4j/2.x/log4j-api-kotlin/kdocs/index.html#org.apache.logging.log4j.kotlin.package)."

 TODO

 ## Requirements

 Log4j Kotlin API requires at least Java 8. This also requires Log4j 2 API, but it is specified as transitive
 dependencies automatically if you are using SBT, Maven, Gradle, or some other similar build system. This also
 requires Log4j 2 Core (or possibly an other implementation of Log4j 2 API) as a runtime dependency. Some
 Log4j 2 Core features require optional dependencies which are documented in the
 [Log4j 2 manual](https://logging.apache.org/log4j/2.x/manual/index.html).

 The Kotlin API requires the full `kotlin-reflect` dependency in order to name loggers appropriately, and
 optionally `kotlinx-coroutines-core` to set the mapped diagnostic context for a coroutine.

 The Kotlin dependencies are not exposed transitively -- for maximum compatibility logging-log4j-kotlin is built
 with Kotlin 1.3, producing binaries that should be forward compatible. For maximum compat, the Kotlin dependencies
 are "provided" i.e. consumers of this library need to depend on them directly rather than transitively, thus
 avoiding version clashes.

 ## License

 Apache Log4j 2 is distributed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

 ## Download

 [How to download Log4j](http://logging.apache.org/log4j/2.x/download.html),
 and [how to use it from SBT, Maven, Ivy and Gradle](http://logging.apache.org/log4j/2.x/maven-artifacts.html).

 ## Issue Tracking

 Issues, bugs, and feature requests should be submitted to the
 [JIRA issue tracking system for this project](https://issues.apache.org/jira/browse/LOG4J2).

 Pull request on GitHub are welcome, but please open a ticket in the JIRA issue tracker first, and mention the
 JIRA issue in the Pull Request.

 ## Building From Source

 Log4j Kotlin API requires Maven 3 and Java 8 to build. To install to your local
 Maven repository, execute the following:

 ```sh
 mvn install
 ```

 ## Contributing

 We love contributions! Take a look at [our contributing page](https://github.com/apache/logging-log4j-kotlin/blob/master/src/main/asciidoc/contributing.adoc).
	# [Apache Log4j 2 (Kotlin API)](http://logging.apache.org/log4j/2.x/)

	Log4j Kotlin API is a Kotlin logging facade based on Log4j 2. Log4j Kotlin API provides Log4j 2 as its
	default logging implementation, but this is not strictly required (e.g., this API can also be used with Logback
	or other Log4j 2 API provider implementations). Idiomatic Kotlin features are provided as an alternative to using
	the Log4j 2 Java API.

	[![Maven Central](https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-api-kotlin.svg)](https://search.maven.org/artifact/org.apache.logging.log4j/log4j-api-kotlin)
	[![Build Status](https://ci-builds.apache.org/job/Logging/job/log4j-kotlin/job/master/lastBuild/badge/icon)](https://builds.apache.org/job/Logging/job/log4j-kotlin/job/master/)

	## Pull Requests on Github

	By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted
	work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the
	Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are
	judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.

	## Usage

	Gradle users can add the following dependencies to their `build.gradle` file:

	TODO

	```groovy
	compile "org.apache.logging.log4j:log4j-api-kotlin:1.2.0"
	compile "org.apache.logging.log4j:log4j-api:2.17.0"
	compile "org.apache.logging.log4j:log4j-core:2.17.0"
	```

	## Documentation

	[//]: # "The Log4j Kotlin API is documented [in the Log4j 2 manual](https://logging.apache.org/log4j/2.x/manual/kotlin-api.html)"
	[//]: # "and in the [KDocs](https://logging.apache.org/log4j/2.x/log4j-api-kotlin/kdocs/index.html#org.apache.logging.log4j.kotlin.package)."

	TODO

	## Requirements

	Log4j Kotlin API requires at least Java 8. This also requires Log4j 2 API, but it is specified as transitive
	dependencies automatically if you are using SBT, Maven, Gradle, or some other similar build system. This also
	requires Log4j 2 Core (or possibly an other implementation of Log4j 2 API) as a runtime dependency. Some
	Log4j 2 Core features require optional dependencies which are documented in the
	[Log4j 2 manual](https://logging.apache.org/log4j/2.x/manual/index.html).

	The Kotlin API requires the full `kotlin-reflect` dependency in order to name loggers appropriately, and
	optionally `kotlinx-coroutines-core` to set the mapped diagnostic context for a coroutine.

	The Kotlin dependencies are not exposed transitively -- for maximum compatibility logging-log4j-kotlin is built
	with Kotlin 1.3, producing binaries that should be forward compatible. For maximum compat, the Kotlin dependencies
	are "provided" i.e. consumers of this library need to depend on them directly rather than transitively, thus
	avoiding version clashes.

	## License

	Apache Log4j 2 is distributed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

	## Download

	[How to download Log4j](http://logging.apache.org/log4j/2.x/download.html),
	and [how to use it from SBT, Maven, Ivy and Gradle](http://logging.apache.org/log4j/2.x/maven-artifacts.html).

	## Issue Tracking

	Issues, bugs, and feature requests should be submitted to the
	[JIRA issue tracking system for this project](https://issues.apache.org/jira/browse/LOG4J2).

	Pull request on GitHub are welcome, but please open a ticket in the JIRA issue tracker first, and mention the
	JIRA issue in the Pull Request.

	## Building From Source

	Log4j Kotlin API requires Maven 3 and Java 8 to build. To install to your local
	Maven repository, execute the following:

	```sh
	mvn install
	```

	## Contributing

	We love contributions! Take a look at [our contributing page](https://github.com/apache/logging-log4j-kotlin/blob/master/src/main/asciidoc/contributing.adoc).