Update README.md

Assembly info and limitations + download links + example code formatting

Author: jason-womack

README.md

@@ -1,8 +1,8 @@
-# solidfire-sdk-java
-Initial wrapping of the SolidFire Management API as a Java SDK
+# SolidFire Java SDK
+SolidFire Management API as a Java SDK
 
 ##Description
-The SolidFire Java SDK is a collection of software modules and libraries that facilitate integration and orchestration between proprietary systems and third-party applications. The Java SDK allows developers to deeply integrate SolidFire system API with their Java programming language. The SolidFire Java SDK reduces the amount of additional coding time required for integration.
+The SolidFire Java SDK is a collection of software modules and libraries that facilitate integration and orchestration between proprietary systems and third-party applications. The Java SDK allows developers to deeply integrate SolidFire system API with the Java programming language. The SolidFire Java SDK reduces the amount of additional coding time required for integration.
 
 ##Compatibility
 | Component    | Version           |
@@ -15,7 +15,8 @@ Contacting SolidFire SDK Support
 If you have any questions or comments about this product, contact <sdk@solidfire.com> or reach out to the developer community at [developer.solidfire.com](http://developer.solidfire.com). Your feedback helps us focus our efforts on new features and capabilities.
 
 ##Download
-Download the latest JAR or grab via Maven:
+[Download](http://mvnrepository.com/artifact/com.solidfire) the latest JAR or grab via Maven:
+
 ```xml
 <dependency>
   <groupId>com.solidfire</groupId>
@@ -25,21 +26,45 @@ Download the latest JAR or grab via Maven:
 ```
 
 or SBT:
+
 ```scala
 libraryDependencies += "com.solidfire" % "element-api" % "1.0.0.47"
 ```
 
 or Gradle:
+
 ```groovy
 compile 'com.solidfire:element-api:1.0.0.47'
 ```
+##Assembly Jar
+The SolidFire Java SDK is also released as a Signed Assembly containing everything you need to quickly spin up a working client to interact with you SolidFire cluster.  The assembly can be downloaded [here](https://github.com/solidfire/solidfire-sdk-java/releases/download/v1.0.0.53/solidfire-sdk-1.0.0.53.jar).  
+
+___Dependencies___:
+
+| Component       | Version |
+| --------------- | ------- |
+| base64          | 2.3.8   |
+| gson            | 2.3     |
+| joda-time       | 2.4     |
+| joda-convert    | 1.2     |
+| slf4j-api       | 1.7.7   |
+| logback-core    | 1.1.3   |
+| logback-classic | 1.1.3   |
+
+_**Note**: The SDK assembly should only be used in a standalone setting such as scripting or for prototyping.  It should not be used in a production environment as the signed components might conflict with other components that are unsigned or signed with another certificate.  See below._   
+
+###Limitations with a Certificate Signed Assembly Jar
+The SDK assembly is signed with a certificate controlled by SolidFire, Inc, assuring the archive is official and legitimate.  One caveat to having a set of components also signed with SolidFire's certificate, is no other version of these components can exist on the classpath. This will cause a security exception in the JVM.  
+
+If using the SDK with a restricted version of the above listed components, e.g. logback, or in developing an enterprise solution that runs in a web application container, etc., use the publicly [hosted versions](http://mvnrepository.com/artifact/com.solidfire) of the SDK.
 
-##Assembly
-###Limitations with Certificate Signed Assembly Jar
-###
 
 ##Documentation
-[JavaDoc](https://solidfire.github.io/solidfire-sdk-java/latest/api/)
+
+[Latest JavaDoc](https://solidfire.github.io/solidfire-sdk-java/latest/api/)
+
+[1.0.0.53 JavaDoc](https://solidfire.github.io/solidfire-sdk-java/doc/1.0.0.53/)
+
 ##Examples
 ###Examples of using the API (Java)
 ```java
@@ -54,11 +79,15 @@ public class ReadmeJavaExample {
     SolidFireElementIF sf = SolidFireElement.create("mvip", "8.0", "username", "password");
 
     // Create some accounts
-    AddAccountRequest addAccountRequest = new AddAccountRequest("username", EMPTY_STRING, EMPTY_STRING, EMPTY_MAP);
+    AddAccountRequest addAccountRequest = new AddAccountRequest("username", EMPTY_STRING, 
+                                                                EMPTY_STRING, EMPTY_MAP);
     Long accountId = sf.addAccount(addAccountRequest).getAccountID();
 
     // And a volume with default QoS
-    CreateVolumeRequest createVolumeRequest = new CreateVolumeRequest("volumeName", accountId, 1000000000l, false, Optional.<QoS>empty(), EMPTY_MAP);
+    CreateVolumeRequest createVolumeRequest = new CreateVolumeRequest("volumeName", accountId, 
+                                                                      1000000000l, false, 
+                                                                      Optional.<QoS>empty(), 
+                                                                      EMPTY_MAP);
     Long volumeId = sf.createVolume(createVolumeRequest).getVolumeID();
 
     // Lookup iqn for new volume
@@ -68,7 +97,10 @@ public class ReadmeJavaExample {
     QoS qos = new QoS(of(5000l), EMPTY_LONG, of(30000l), EMPTY_LONG );
 
     // Modify the volume size and QoS
-    ModifyVolumeRequest modifyVolumeRequest = new ModifyVolumeRequest(volumeId, EMPTY_LONG, EMPTY_STRING, EMPTY_STRING, of(qos), of(2000000000l), EMPTY_MAP)
+    ModifyVolumeRequest modifyVolumeRequest = new ModifyVolumeRequest(volumeId, EMPTY_LONG, 
+                                                                      EMPTY_STRING, EMPTY_STRING, 
+                                                                      of(qos), of(2000000000l),
+                                                                      EMPTY_MAP)
     sf.modifyVolume(modifyVolumeRequest);
   }
 }
@@ -87,25 +119,29 @@ class ReadmeExample {
   val sf = SolidFireElement.create( "mvip", "8.0", "username", "password" )
 
   // Create some accounts
-  val addAccount = new AddAccountRequest( "username", empty[String], empty[String], empty( ) )
-  val accountId = sf.addAccount( addAccount  ).getAccountID
+  val addAccount = new AddAccountRequest( "username", empty[String], empty[String], empty())
+  val accountId = sf.addAccount(addAccount).getAccountID
 
   // And a volume
-  val createVolume = new CreateVolumeRequest( "volumeName", accountId, 1000000000l, false, empty[QoS], empty( ) )
-  val volumeId = sf.createVolume( createVolume ).getVolumeID
+  val createVolume = new CreateVolumeRequest( "volumeName", accountId, 1000000000l, false, empty[QoS], empty())
+  val volumeId = sf.createVolume(createVolume).getVolumeID
 
   // Lookup iqn for new volume
-  val iqn: String = sf.listVolumesForAccount( accountId, of( volumeId ), of( 1l ) ).getVolumes( )( 0 ).getIqn
+  val iqn: String = sf.listVolumesForAccount( accountId, of(volumeId), of(1l)).getVolumes()(0).getIqn
 
   // Change Min and Burst QoS while keeping Max and Burst Time the same
-  val qos: QoS = new QoS( of( 5000l ), empty[Long], of( 30000l ), empty[Long] )
+  val qos: QoS = new QoS(of(5000l), empty[Long], of(30000l), empty[Long])
 
   // Modify the volume
-  val modifyVolume = new ModifyVolumeRequest( volumeId, empty[Long], empty[String], empty[String], of( qos ), of( 2000000000l ), empty( ) )
+  val modifyVolume = new ModifyVolumeRequest(volumeId, empty[Long], empty[String], empty[String], 
+                                            of(qos), of( 2000000000l ), empty() )
   sf.modifyVolume( modifyVolume  )
 }
 ```
 ##Roadmap
+
+___TBD___
+
 ##License
 Copyright © 2015 SolidFire, Inc. All rights reserved.