Add download page
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/6cb937c2 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/tree/6cb937c2 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/diff/6cb937c2 Branch: refs/heads/sbt Commit: 6cb937c2d622b88a0c9c0de08b33912196259a72 Parents: a42494a Author: Matt Sicker <boa...@gmail.com> Authored: Sat Mar 31 19:54:36 2018 -0500 Committer: Matt Sicker <boa...@gmail.com> Committed: Sat Mar 31 19:54:36 2018 -0500 ---------------------------------------------------------------------- src/asciidoctor/download.adoc | 74 ++++++++++++++++++++++++++++++++++++++ src/asciidoctor/index.adoc | 5 ++- src/asciidoctor/usage.adoc | 11 ------ 3 files changed, 78 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/6cb937c2/src/asciidoctor/download.adoc ---------------------------------------------------------------------- diff --git a/src/asciidoctor/download.adoc b/src/asciidoctor/download.adoc new file mode 100644 index 0000000..2d11fc9 --- /dev/null +++ b/src/asciidoctor/download.adoc @@ -0,0 +1,74 @@ +//// + 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. +//// +== Download + +Apache Log4j Scala API is distributed under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache License, version 2.0]. +The link in the Mirrors column should display a list of available mirrors with a default selection based on your inferred location. +If you do not see that page, try a different browser. +The checksum and signature are links to the originals on the main distribution server. + +|=== +|Distribution |Mirrors |Signature + +|Apache Log4j Scala API binary (tar.gz) +|https://www.apache.org/dyn/closer.lua/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-bin.tar.gz[apache-log4j-scala-{project-version}-bin.tar.gz] +|https://www.apache.org/dist/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-bin.tar.gz.asc[apache-log4j-scala-{project-version}-bin.tar.gz.asc] + +|Apache Log4j Scala API binary (zip) +|https://www.apache.org/dyn/closer.lua/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-bin.zip[apache-log4j-scala-{project-version}-bin.zip] +|https://www.apache.org/dist/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-bin.zip.asc[apache-log4j-scala-{project-version}-bin.zip.asc] + +|Apache Log4j Scala API source (tar.gz) +|https://www.apache.org/dyn/closer.lua/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-src.tar.gz[apache-log4j-scala-{project-version}-src.tar.gz] +|https://www.apache.org/dist/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-src.tar.gz.asc[apache-log4j-scala-{project-version}-src.tar.gz.asc] + +|Apache Log4j Scala API binary (zip) +|https://www.apache.org/dyn/closer.lua/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-src.zip[apache-log4j-scala-{project-version}-src.zip] +|https://www.apache.org/dist/logging/log4j/scala/{project-version}/apache-log4j-scala-{project-version}-src.zip.asc[apache-log4j-scala-{project-version}-src.zip.asc] +|=== + +It is essential that you verify the integrity of the downloaded files using the PGP or MD5 signatures. +Please read https://httpd.apache.org/dev/verification.html[Verifying Apache HTTP Server Releases] for more information on why you should verify our releases. + +The PGP signatures can be verified using PGP or GPG. +First download the https://www.apache.org/dist/logging/KEYS[KEYS] as well as the asc signature file for the relevant distribution. +Make sure you get these files from the https://www.apache.org/dist/logging/[main distribution directory], rather than from a mirror. +Then verify the signatures using: + +[source,bash,subs=attributes] +---- +gpg --import KEYS +gpg --verify apache-log4j-scala-{project-version}-bin.tar.gz.asc apache-log4j-scala-{project-version}-bin.tar.gz +gpg --verify apache-log4j-scala-{project-version}-bin.zip.asc apache-log4j-scala-{project-version}-bin.zip +gpg --verify apache-log4j-scala-{project-version}-src.tar.gz.asc apache-log4j-scala-{project-version}-src.tar.gz +gpg --verify apache-log4j-scala-{project-version}-src.zip.asc apache-log4j-scala-{project-version}-src.zip +---- + +Log4j Scala API requires https://logging.apache.org/log4j/2.x/download.html[Log4j API]. + +=== Using SBT + +How to add Log4j Scala API to your project using Log4j 2: + +.build.sbt +[source,scala,subs=attributes] +---- +libraryDependencies ++= Seq( + "org.apache.logging.log4j" %% "log4j-api-scala" % "{project-version}", + "org.apache.logging.log4j" % "log4j-core" % "2.11.0" % Runtime +) +---- http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/6cb937c2/src/asciidoctor/index.adoc ---------------------------------------------------------------------- diff --git a/src/asciidoctor/index.adoc b/src/asciidoctor/index.adoc index 913809b..6eccdfb 100644 --- a/src/asciidoctor/index.adoc +++ b/src/asciidoctor/index.adoc @@ -24,12 +24,15 @@ While this library is not required to use Log4j API in Scala, it does provide id include::usage.adoc[] +include::download.adoc[] + include::changes.adoc[] +include::build.adoc[] + //// TODO: * Apache logo -* Downloads page * License report * ScalaDocs links * Project links http://git-wip-us.apache.org/repos/asf/logging-log4j-scala/blob/6cb937c2/src/asciidoctor/usage.adoc ---------------------------------------------------------------------- diff --git a/src/asciidoctor/usage.adoc b/src/asciidoctor/usage.adoc index 9300963..cc65bad 100644 --- a/src/asciidoctor/usage.adoc +++ b/src/asciidoctor/usage.adoc @@ -16,17 +16,6 @@ //// == Usage -Log4j Scala API requires Log4j API. An example SBT dependency setup: - -.build.sbt -[source,scala,subs=attributes] ----- -libraryDependencies ++= Seq( - "org.apache.logging.log4j" %% "log4j-api-scala" % "{project-version}", - "org.apache.logging.log4j" % "log4j-api" % "2.11.0", - "org.apache.logging.log4j" % "log4j-core" % "2.11.0" % Runtime) ----- - Using the Scala API is as simple as mixing in the `Logging` trait to your class. Example: [source,scala]