svn commit: r1542962 - /sling/trunk/bundles/commons/log/README.md

[ch...@apache.org]

Author: chetanm
Date: Mon Nov 18 10:02:39 2013
New Revision: 1542962

URL: http://svn.apache.org/r1542962
Log:
SLING-2024 - Replace file logger with logback

Updated the readme to reflect current state

Added:
    sling/trunk/bundles/commons/log/README.md

Added: sling/trunk/bundles/commons/log/README.md
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/log/README.md?rev=1542962&view=auto
==============================================================================
--- sling/trunk/bundles/commons/log/README.md (added)
+++ sling/trunk/bundles/commons/log/README.md Mon Nov 18 10:02:39 2013
@@ -0,0 +1,30 @@
+Apache Sling Commons Log
+========================
+
+The "log" project packages the [Logback][2] library to manage logging
+in OSGi environment. It provide some useful extension to the default
+Logback feature set to enable better integration with OSGi. The SLF4j
+API bundle must be installed along with this bundle to provide full SLF4J
+logging support.
+  
+The Logging bundle should be installed as one of the first modules in
+the OSGi framework and - provided the framework supports start levels -
+be set to start at start level 1. This ensures the Logging bundle is
+loaded as early as possible thus providing services to the framework
+and preparing logging.
+
+For more details refer to the [Logging Documentation][1]
+
+Getting Started
+===============
+
+You can compile and package the jar using the following command:
+
+    mvn package -Pide,coverage
+
+It would build the module and also produce a test coverage report also
+prepare bundle jar which is suitable to be used to run integration test
+from within IDE.
+
+[1]: http://sling.apache.org/documentation/development/logging.html
+[2]: http://logback.qos.ch/