This is an automated email from the ASF dual-hosted git repository. vy pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 8fa369a6df76ea1bb8fe5d30148a7ee320908591 Author: Volkan Yazıcı <[email protected]> AuthorDate: Mon Nov 27 22:04:50 2023 +0100 Revamp README --- README.adoc | 23 ++++++++++++ README.md | 117 ------------------------------------------------------------ 2 files changed, 23 insertions(+), 117 deletions(-) diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000000..8c85d68c66 --- /dev/null +++ b/README.adoc @@ -0,0 +1,23 @@ +//// + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +//// + +https://github.com/apache/logging-log4j2/actions/workflows/build.yaml[image:https://img.shields.io/github/actions/workflow/status/apache/logging-log4j2/build.yaml?branch=main&label=build%20%283.x%29[Build (3.x)]] +https://search.maven.org/artifact/org.apache.logging.log4j/log4j-api[image:https://img.shields.io/maven-central/v/org.apache.logging.log4j/log4j-api?versionPrefix=3.[Maven Central (3.x)]] +https://github.com/apache/logging-log4j2/security/code-scanning[image:https://github.com/apache/logging-log4j2/actions/workflows/codeql-analysis.yaml/badge.svg?branch=main[CodeQL (3.x)]] + +Apache Log4j is a versatile, industrial-grade Java logging framework composed of an API, its implementation, and components to assist the deployment for various use cases. +For further information (support, download, etc.) see https://logging.apache.org/log4j[the project website]. diff --git a/README.md b/README.md deleted file mode 100644 index 83534e3430..0000000000 --- a/README.md +++ /dev/null @@ -1,117 +0,0 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -# [Apache Log4j 3.x](https://logging.apache.org/log4j/2.x/) - -Apache Log4j 3.x is an upgrade to Log4j that provides significant improvements over its predecessor, Log4j 1.x, -and provides many of the improvements available in Logback while fixing some inherent problems in Logback's architecture. - -[](https://search.maven.org/artifact/org.apache.logging.log4j/log4j-api) -[](https://github.com/apache/logging-log4j2/actions/workflows/build.yml) -[](https://github.com/apache/logging-log4j2/actions/workflows/build.yml) - - -## 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 sign a [Contributor License Agreement](https://www.apache.org/licenses/icla.pdf). - -## Usage - -Users should refer to [Maven, Ivy, Gradle, and SBT Artifacts](http://logging.apache.org/log4j/2.x/maven-artifacts.html) -on the Log4j web site for instructions on how to include Log4j into their project using their chosen build tool. - -Basic usage of the `Logger` API: - -```java -package com.example; - -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.LogManager; - -public class Example { - private static final Logger LOGGER = LogManager.getLogger(); - - public static void main(String... args) { - String thing = args.length > 0 ? args[0] : "world"; - LOGGER.info("Hello, {}!", thing); - LOGGER.debug("Got calculated value only if debug enabled: {}", () -> doSomeCalculation()); - } - - private static Object doSomeCalculation() { - // do some complicated calculation - } -} -``` - -And an example `log4j2.xml` configuration file: - -```xml -<?xml version="1.0" encoding="UTF-8"?> -<Configuration> - <Appenders> - <Console name="Console" target="SYSTEM_OUT"> - <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> - </Console> - </Appenders> - <Loggers> - <Logger name="com.example" level="INFO"/> - <Root level="error"> - <AppenderRef ref="Console"/> - </Root> - </Loggers> -</Configuration> -``` - -## Documentation - -The Log4j 3.x User's Guide is available [here](https://logging.apache.org/log4j/2.x/manual/index.html) or as a downloadable -[PDF](https://logging.apache.org/log4j/2.x/log4j-users-guide.pdf). - -## Requirements - -Log4j 3.0 and greater requires Java 11. -Some features require optional dependencies; the documentation for these features specifies the dependencies. - -## License - -Apache Log4j 3.x 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 Maven, Ivy and Gradle](http://logging.apache.org/log4j/2.x/maven-artifacts.html). -You can access the latest development snapshot by using the Maven repository `https://repository.apache.org/snapshots`, -see [Snapshot builds](https://logging.apache.org/log4j/2.x/maven-artifacts.html#Snapshot_builds). - -## Issue Tracking - -Issues, bugs, and feature requests should be submitted to the -[the issue tracking system for this project](https://github.com/apache/logging-log4j2/issues). - -Pull requests on GitHub are welcome, but please open a ticket in the issue tracker first, and mention the issue in the pull request. - -## Building From Source - -See [the detailed build instructions](BUILDING.md) on how to build to the project and website from sources. - -## Contributing - -We love contributions! -Take a look at [our contributing page](CONTRIBUTING.md).
