diff --git a/README.md b/README.md index ede189d..ed795da 100644 --- a/README.md +++ b/README.md @@ -45,3 +45,77 @@ The path to the unsigned module. ### module-out The path the signed module will be written to. + + +## Using as a Library via Maven + +This library has been built and published to the Inductive Automation artifact repository. To use this as a dependency in a JVM project, simply add the IA repo to your artifact repositories, and then add as a typical maven dependency. + + +#### Consuming Via Maven POM + +``` + // in pom.xml + + + + ia-releases + true + false + https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/ + + + + + + + com.inductiveautomation.ignitionsdk + module-signer + YOUR_DESIRED_VERSION + + +``` + +#### Consuming Via Gradle buildscript + +``` + // in build.gradle + repositories { + maven { url "https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/" } + } + + dependencies { + implementation("com.inductiveautomation.ignitionsdk:module-signer:YOUR_DESIRED_VERSION") + } + +``` + + +## Artifact Publishing + +To publish a copy of this artifact to a private repo, you'll need to configure your server settings as described in the [Maven deploy documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html). Specify the repo urls by directly editing the POM file and setting the urls. Alternatively, you may set the properties through an active profile in your settings.xml file (generally located at `${user.home}/.m2/settings.xml`) as demonstrated below. + +Then simply execute `mvn deploy` to publish to your private repository. For development and testing, `mvn install` will install the assembled artifact to your local maven .m2 repository. + + +``` + + + + inject-repo-url + + http://your-artifact-host/repository/snapshots/ + http://your-artifact-host/repository/releases/ + + + + + inject-repo-url + + +// ... + + + +``` + diff --git a/pom.xml b/pom.xml index 4bfe5c0..f0be86e 100644 --- a/pom.xml +++ b/pom.xml @@ -8,6 +8,18 @@ module-signer 1.0.0-SNAPSHOT + + https://github.com/inductiveautomation/module-signer + scm:git:git://github.com/inductiveautomation/module-signer.git + scm:git:git@github.com:inductiveautomation/module-signer.git + HEAD + + + + UTF-8 + UTF-8 + + commons-cli @@ -66,7 +78,34 @@ + + org.apache.maven.plugins + maven-deploy-plugin + 2.8.2 + + + default-deploy + deploy + + deploy + + + + + + + snapshots + + ${snapshotsRepoUrl} + + + releases + + ${releasesRepoUrl} + + +