Repository: logging-log4j-scala
Updated Branches:
  refs/heads/master 7699ccc05 -> fe7b1334c


Add intro to README


Project: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/commit/fe7b1334
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/tree/fe7b1334
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/diff/fe7b1334

Branch: refs/heads/master
Commit: fe7b1334c40df5dfaab17c5f7211b1f00297edca
Parents: 7699ccc
Author: Matt Sicker <boa...@gmail.com>
Authored: Sat Jan 28 13:29:06 2017 -0600
Committer: Matt Sicker <boa...@gmail.com>
Committed: Sat Jan 28 13:29:06 2017 -0600

----------------------------------------------------------------------
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/fe7b1334/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4245683..baa6254 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,16 @@
 # [Apache Log4j 2 Scala API](http://logging.apache.org/log4j/2.x/)
 
+Log4j Scala API is a Scala logging facade based on Log4j 2. This supports
+Scala 2.10, 2.11, and 2.12, on Java 7 at minimum. Log4j Scala 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 Scala features are provided as an
+alternative to using the Log4j 2 Java API.
+
+Note that Scala 2.12 support requires Java 8 at minimum and was introduced
+as in Log4j 2.8.1 (earlier versions of Log4j Scala API do not have Scala
+2.12 compatible binaries available other than in nightly snapshots).
+
 [![Build 
Status](https://builds.apache.org/buildStatus/icon?job=Log4jScala)](https://builds.apache.org/job/Log4jScala)
 
 ## Usage

Reply via email to