summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2018-09-06 23:37:29 -0400
committerPaul Duncan <pabs@pablotron.org>2018-09-06 23:37:29 -0400
commit7798c9eff73a6650f2aa91a905ebfd773090425d (patch)
tree64aa8f20a375fcaf0be70472ee0d1b8df4466cf8
parentba2276390ae29a710d09977e96b9b8549fc08b29 (diff)
downloadluigi-template-7798c9eff73a6650f2aa91a905ebfd773090425d.tar.bz2
luigi-template-7798c9eff73a6650f2aa91a905ebfd773090425d.zip
java: populate documentation, license, and author section of README, ruby: update copyright year
-rw-r--r--java/README.mkd47
-rw-r--r--ruby/README.mkd2
2 files changed, 48 insertions, 1 deletions
diff --git a/java/README.mkd b/java/README.mkd
index 79065f1..35f9446 100644
--- a/java/README.mkd
+++ b/java/README.mkd
@@ -6,7 +6,54 @@ Installation
mvn package
+Documentation
+-------------
+Luigi Template uses the [maven-javadoc-plugin][] to generate API
+documentation.
+
+To generate API documentation in `target/apidocs/`:
+
+ mvn javadoc:javadoc
+
+To generate API documentation as a `jar` file:
+
+ mvn javadoc:jar
+
+See [this page][maven-javadoc-plugin-usage] for additional options.
+
Tests
-----
mvn test
+
+Author
+------
+Paul Duncan ([pabs@pablotron.org][me])<br/>
+https://pablotron.org/
+
+License
+-------
+Copyright 2010-2018 Paul Duncan ([pabs@pablotron.org][me])
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[me]: mailto:pabs@pablotron.org
+[maven-javadoc-plugin]: https://maven.apache.org/plugins/maven-javadoc-plugin/
+[maven-javadoc-plugin-usage]: https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html
diff --git a/ruby/README.mkd b/ruby/README.mkd
index d804bb5..6676988 100644
--- a/ruby/README.mkd
+++ b/ruby/README.mkd
@@ -46,7 +46,7 @@ https://pablotron.org/
License
-------
-Copyright 2007-2018 Paul Duncan ([pabs@pablotron.org][me])
+Copyright 2010-2018 Paul Duncan ([pabs@pablotron.org][me])
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the