Add generated README master
authorMark Thomas <markt@apache.org>
Mon, 30 Apr 2018 20:29:38 +0000 (21:29 +0100)
committerMark Thomas <markt@apache.org>
Mon, 30 Apr 2018 20:29:38 +0000 (21:29 +0100)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f6639d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,105 @@
+<!---\r
+ Licensed to the Apache Software Foundation (ASF) under one or more\r
+ contributor license agreements.  See the NOTICE file distributed with\r
+ this work for additional information regarding copyright ownership.\r
+ The ASF licenses this file to You under the Apache License, Version 2.0\r
+ (the "License"); you may not use this file except in compliance with\r
+ the License.  You may obtain a copy of the License at\r
+\r
+      http://www.apache.org/licenses/LICENSE-2.0\r
+\r
+ Unless required by applicable law or agreed to in writing, software\r
+ distributed under the License is distributed on an "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ See the License for the specific language governing permissions and\r
+ limitations under the License.\r
+-->\r
+<!---\r
+ +======================================================================+\r
+ |****                                                              ****|\r
+ |****      THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN      ****|\r
+ |****                    DO NOT EDIT DIRECTLY                      ****|\r
+ |****                                                              ****|\r
+ +======================================================================+\r
+ | TEMPLATE FILE: readme-md-template.md                                 |\r
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |\r
+ +======================================================================+\r
+ |                                                                      |\r
+ | 1) Re-generate using: mvn commons:readme-md                          |\r
+ |                                                                      |\r
+ | 2) Set the following properties in the component's pom:              |\r
+ |    - commons.componentid (required, alphabetic, lower case)          |\r
+ |    - commons.release.version (required)                              |\r
+ |                                                                      |\r
+ | 3) Example Properties                                                |\r
+ |                                                                      |\r
+ |  <properties>                                                        |\r
+ |    <commons.componentid>math</commons.componentid>                   |\r
+ |    <commons.release.version>1.2</commons.release.version>            |\r
+ |  </properties>                                                       |\r
+ |                                                                      |\r
+ +======================================================================+\r
+--->\r
+Apache Commons Signing\r
+===================\r
+\r
+[![Build Status](https://travis-ci.org/apache/commons-signing.svg?branch=master)](https://travis-ci.org/apache/commons-signing)\r
+[![Coverage Status](https://coveralls.io/repos/apache/commons-signing/badge.svg?branch=master)](https://coveralls.io/r/apache/commons-signing)\r
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-signing/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-signing/)\r
+[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)\r
+\r
+The Apache Commons Code Signing Library.\r
+\r
+Documentation\r
+-------------\r
+\r
+More information can be found on the [Apache Commons Signing homepage](https://commons.apache.org/proper/commons-signing).\r
+The [JavaDoc](https://commons.apache.org/proper/commons-signing/javadocs/api-release) can be browsed.\r
+Questions related to the usage of Apache Commons Signing should be posted to the [user mailing list][ml].\r
+\r
+Where can I get the latest release?\r
+-----------------------------------\r
+You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-signing/download_signing.cgi).\r
+\r
+Alternatively you can pull it from the central Maven repositories:\r
+\r
+```xml\r
+<dependency>\r
+  <groupId>org.apache.commons</groupId>\r
+  <artifactId>commons-signing</artifactId>\r
+  <version>0.0.1</version>\r
+</dependency>\r
+```\r
+\r
+Contributing\r
+------------\r
+\r
+We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors.\r
+There are some guidelines which will make applying PRs easier for us:\r
++ No tabs! Please use spaces for indentation.\r
++ Respect the code style.\r
++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.\r
++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```.\r
+\r
+If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas).\r
+You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md).\r
+\r
+License\r
+-------\r
+This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0).\r
+\r
+See the `NOTICE.txt` file for required notices and attributions.\r
+\r
+Donations\r
+---------\r
+You like Apache Commons Signing? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development.\r
+\r
+Additional Resources\r
+--------------------\r
+\r
++ [Apache Commons Homepage](https://commons.apache.org/)\r
++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SIGNING)\r
++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons)\r
++ `#apache-commons` IRC channel on `irc.freenode.org`\r
+\r
+[ml]:https://commons.apache.org/mail-lists.html\r