You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by cz...@apache.org on 2025/04/16 05:21:19 UTC
(sling-org-apache-sling-commons-log) branch master updated: Update README.md
This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-log.git
The following commit(s) were added to refs/heads/master by this push:
new e101692 Update README.md
e101692 is described below
commit e10169299ebef1264e44ddc1664f28303238f771
Author: Carsten Ziegeler <cz...@apache.org>
AuthorDate: Wed Apr 16 07:21:15 2025 +0200
Update README.md
---
README.md | 28 +++++++++-------------------
1 file changed, 9 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 65e63ee..739ee0f 100644
--- a/README.md
+++ b/README.md
@@ -6,30 +6,20 @@
This module is part of the [Apache Sling](https://sling.apache.org) project.
-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.
+The "log" module provides some useful extension to the default [Logback][2] feature set to enable better integration with OSGi.
+
+## Installation
+
+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
-===============
+## Getting Started
You can compile and package the jar using the following command:
- mvn package -Pide,coverage
+ mvn package
-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/
+[1]: https://sling.apache.org/documentation/development/logging.html
+[2]: https://logback.qos.ch/