Reformat README, update license plugin, add plugin-version.properties

README.md

@@ -1,10 +1,4 @@
-# Preface #
-
-This document describes the functionality provided by the xlr-xlrelease-plugin.
-
-See the **[XL Release Documentation](https://docs.xebialabs.com/xl-release/index.html)** for background information on XL Release and release concepts.
-
-# CI status #
+# XL Release XL Release plugin
 
 [![Build Status][xlr-xlrelease-travis-image] ][xlr-xlrelease-travis-url]
 [![Codacy Status][xlr-xlrelease-codacy-image] ][xlr-xlrelease-codacy-url]
@@ -21,7 +15,14 @@ See the **[XL Release Documentation](https://docs.xebialabs.com/xl-release/index
 [xlr-xlrelease-plugin-license-image]: https://img.shields.io/badge/License-MIT-yellow.svg
 [xlr-xlrelease-plugin-license-url]: https://opensource.org/licenses/MIT
 
-# Overview #
+## Preface
+
+This document describes the functionality provided by the xlr-xlrelease-plugin.
+
+See the **[XL Release Documentation](https://docs.xebialabs.com/xl-release/index.html)** for background information on XL Release and release concepts.
+
+
+## Overview
 
 The xlr-xlrelease-plugin is an XL Release plugin that allows you to:
 
@@ -31,6 +32,14 @@ The xlr-xlrelease-plugin is an XL Release plugin that allows you to:
 
 For XL Release version 4.8.x you'll need at least version 1.7.x of the plugin.
 
+## Requirements
+
+* XL Release 5.0+
+
+## Installation
+
+* Copy the latest JAR file from the [releases page](https://github.com/xebialabs-community/xlr-xlrelease-plugin/releases) into the `XL_RELEASE_SERVER/plugins` directory.
+* Restart the XL Release server.
 
 ## Tasks ##
 + Create and Start SubRelease

build.gradle

@@ -1,5 +1,7 @@
+import org.apache.tools.ant.filters.ReplaceTokens
+
 plugins {
-  id "com.github.hierynomus.license" version "0.13.1"
+  id "com.github.hierynomus.license" version "0.14.0"
   id "com.xebialabs.xl.docker" version "1.0.0"
 }
 
@@ -18,6 +20,13 @@ xlDocker {
   runPortMapping = '15516:5516'
 }
 
+processResources.configure {
+  filter ReplaceTokens, tokens: [
+    'project.version': version.toString(),
+    'project.name'   : rootProject.name
+  ]
+}
+
 license {
     header rootProject.file('License.md')
     strictCheck true

src/main/resources/plugin-version.properties

@@ -0,0 +1,12 @@
+#
+# Copyright 2017 XEBIALABS
+#
+# 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.
+#
+
+plugin=@project.name@
+version=@project.version@