- realign the version numbers

- add a simple assembly descriptor for building the release
- update README

README.md

@@ -5,6 +5,11 @@ AWS ES service authenticator for JanusGraph ES indexing backend based on aws-sig
 
 A custom authenticator for [JanusGraph](https://github.com/JanusGraph/janusgraph) ES indexing backend created to support AWS' [Elasticsearch Service](https://aws.amazon.com/elasticsearch-service/).
 
+Building
+--------
+
+Run `mvn clean package` and use the ZIP file from target/ directory. This ZIP file will contain all JARs needed to be made available to JanusGraph in its "lib" directory".
+
 Usage
 -----
 
@@ -18,7 +23,7 @@ index.<index-name>.elasticsearch.elasticsearch.http.auth.custom.authenticator-ar
 This authenticator does not require any arguments. It relies on both AWS default credentials provider chain (http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) and default region provider chain (http://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html). So it may be useful in the environments like AWS Elastic Container Service etc.
 
 
-JanusGraph version note
------------------------
+JanusGraph minimal version
+--------------------------
 
-For now this module is based on an unreleased (and also unmerged) set of changes extending JanusGraph ES REST API support to support the custom authenticators. This README will be updated once this support is available.
+The functionality this module depends on is available in JanusGraph as of version 0.3.0.

pom.xml

@@ -3,14 +3,16 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.newforma</groupId>
 	<artifactId>janusgraph-es-aws-authenticator</artifactId>
-	<version>0.0.1-SNAPSHOT</version>
+	<!-- will align the version of the authenticator to JG version -->
+	<version>0.3.1</version>
 	<name>JanusGraph AWS Authenticator</name>
 	<description>A plug-in for JanusGraph ES REST providing performing authentication for AWS ES service</description>
 	<properties>
-		<janusgraph.es.version>0.2.0</janusgraph.es.version>
-		<aws.signing.interceptor>0.0.20</aws.signing.interceptor>
-		<aws.java.sdk.version>1.11.125</aws.java.sdk.version>
-		<dependency.plugin.version>3.0.2</dependency.plugin.version>
+		<janusgraph.es.version>0.3.1</janusgraph.es.version>
+		<aws.signing.interceptor>0.0.22</aws.signing.interceptor>
+		<!-- aligned to the version of AWS SDK used by the latest JG DynamoDB storage backend -->
+		<aws.java.sdk.version>1.11.281</aws.java.sdk.version>
+		<dependency.plugin.version>3.1.1</dependency.plugin.version>
 	</properties>
 	<dependencies>
 		<dependency>
@@ -62,6 +64,24 @@
 					</execution>
 				</executions>
 			</plugin>
+            		<plugin>
+                		<groupId>org.apache.maven.plugins</groupId>
+                		<artifactId>maven-assembly-plugin</artifactId>
+                		<executions>
+                    			<execution>
+                        			<phase>package</phase>
+                        			<goals>
+                            				<goal>single</goal>
+                        			</goals>
+                        			<configuration>
+                            				<appendAssemblyId>false</appendAssemblyId>
+                            				<descriptors>
+                                				<descriptor>src/main/assembly/zip.xml</descriptor>
+                            				</descriptors>
+                        			</configuration>
+                    			</execution>
+                		</executions>
+            		</plugin>
 		</plugins>
 	</build>
-</project>
+</project>

src/main/assembly/zip.xml

@@ -0,0 +1,32 @@
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+    <id>zip</id>
+    <includeBaseDirectory>true</includeBaseDirectory>
+
+    <formats>
+        <format>zip</format>
+    </formats>
+    <files>
+        <file>
+            <source>${project.basedir}/README.md</source>
+            <outputDirectory>/</outputDirectory>
+        </file>
+        <file>
+            <source>${project.basedir}/LICENSE</source>
+            <outputDirectory>/</outputDirectory>
+        </file>
+        <file>
+            <source>${project.build.directory}/${project.artifactId}-${project.version}.jar</source>
+            <outputDirectory>/lib</outputDirectory>
+        </file>
+    </files>
+    <dependencySets>
+        <dependencySet>
+            <outputDirectory>/lib</outputDirectory>
+            <excludes>
+                <exclude>${project.groupId}:${project.artifactId}:jar:*</exclude>
+            </excludes>
+        </dependencySet>
+    </dependencySets>
+</assembly>