diff --git a/README.md b/README.md index 3259206..041b29d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,64 @@ -# farsight-wm-parent +# farsight:is-package-maven-plugin [![License: MIT](https://img.shields.io/badge/License-MIT-silver.svg)](https://opensource.org/licenses/MIT) A small maven-plugin assisting in building IS-packages that depend on jar files. ## Features - - copy jar files from compile or runtime dependencies into the code/jars (/static) directory of the is package. + - copy jar files from compile or runtime dependencies into the `code/jars (/static)` directory of the is package. -## Nice-to-Have Features - - compile java services - - create java service nodes from annotations in the source code - - create importable zip archive - - create/update entries in mainfest.v3 \ No newline at end of file +## Usage + 1. Create the sources for the IS package(s) (eg. in the folder `src/is/` + 1. Configure your build to use the plugin: + +```xml + + farsight-wm + is-package-maven-plugin + 1.0.0 + + + + is-package + + + + + name-of-IS-package + + + + + + + + + + + +``` + +You can add multiple packages with multiple jars. Each jar entry can have the keys: + +| key | required | type | description | +| --------- | -------- | ---------- | --------------------- | +| id | yes | `String` | Id that defines the dependency (Format `:`) | +| staticJar | no | `Boolean` | If true the jar will be placed in `code/jars/static`. Default is false. | +| filename | no | `String` | If provided the jar will get the defined filename. If not the jar is named `-.jar` | + +The output will be generated in `target/is/` +The input and output directory can be modified by setting `source` and `target` plugin parameter. E.g: +```xml + + + src/main/is + target/is-packages + +``` +Default source is `src/is` +Default target is `target/is` + +## Nice-to-Have Features / TODO + - [ ] compile java services + - [ ] create java service nodes from annotations in the source code + - [ ] create importable zip archive + - [ ] create/update entries in mainfest.v3 diff --git a/pom.xml b/pom.xml index b21ad7a..a43bc45 100644 --- a/pom.xml +++ b/pom.xml @@ -10,6 +10,9 @@ 1.0.0 farsight-wm:is-package-maven-plugin + + A maven plugin that helps in building IS packages. + https://github.com/farsight-wm/is-package-maven-plugin @@ -23,7 +26,7 @@ scm:git:https://github.com/farsight-wm/is-package-maven-plugin.git HEAD - + The MIT License (MIT)