better documentation v0.62 release

build.gradle

@@ -17,8 +17,6 @@ buildscript {
 
 
 
-//apply plugin: 'com.github.lkishalmi.bill-of-materials'
-//apply from: "$rootDir/versions.gradle"
 
 subprojects {
 	apply plugin:'java'

gradle.properties

@@ -1,4 +1,4 @@
-version=0.61
+version=0.62
 springVersion=4.1.5.RELEASE
 jerseyVersion=2.19
 grizzlyVersion=2.3.21

micro-boot/build.gradle

@@ -24,7 +24,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-boot'
+		artifactId 'micro-boot'
 		version "$version" 
 
 		scm {

micro-boot/readme.md

@@ -0,0 +1,50 @@
+# Spring Boot entry point for Microserver
+
+[micro-boot example apps](https://github.com/aol/micro-server/tree/master/micro-boot/src/test/java/app)
+
+## To use
+
+Add micro-boot to the classpath
+
+Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-boot</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-boot:0.62'
+
+ And also add Grizzly and Jersey (micro-grizzly-with-jersey will add both)
+
+ Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-grizzly-with-jersey</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-grizzly-with-jersey:0.62'
+
+
+ ## Create a simple server
+
+     public class SimpleApp {
+
+	   public static void main(String[] args){
+		   new MicrobootApp(()->"test-app").run();
+	   }
+
+     }
+
+ # Relationship to Microserver and Spring Boot
+
+ micro-boot allows you to use Microserver  plugins & jax-rs support with Spring Boot back ends.
+
+ micro-boot apps are started via the MicrobootApp (equivalent to MicroserverApp) and configured via the Microboot annotation (equivalent to the Microserver annotation)

micro-client/build.gradle

@@ -24,7 +24,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-client'
+		artifactId 'micro-client'
 		version "$version" 
 
 

micro-client/readme.md

@@ -1,5 +1,7 @@
 # REST client plugin for Microserver
 
+[micro-client example apps](https://github.com/aol/micro-server/tree/master/micro-client/src/test/java/app)
+
 This plugin provides two REST Clients
 
 1. NIORestClient - which is a non-blocking REST client using NIO
@@ -15,10 +17,10 @@ Maven
 
      <dependency>
         <groupId>com.aol.microservices</groupId>  
-        <artifactId>microserver-client</artifactId>
-        <version>0.61</version>
+        <artifactId>micro-client</artifactId>
+        <version>0.62</version>
      </dependency>
      
 Gradle
 
-    compile 'com.aol.microservices:microserver-client:0.61'
+    compile 'com.aol.microservices:micro-client:0.62'

micro-core/build.gradle

@@ -41,20 +41,9 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-core'
+		artifactId 'micro-core'
 		version "$version" 
 
-		dependencyManagement {
-			dependencies{
-				dependency{
-					groupId 'org.springframework'
-					artifactId 'spring-framework-bom'
-					version '4.1.5.RELEASE'
-					type 'pom'
-					scope 'import'
-				}
-			}
-		}
 
 		scm {
 			url 'scm:[email protected]:aol/micro-server.git'

micro-core/readme.md

@@ -1,3 +1,19 @@
 # The core of Microserver
 
-This module imports your configured plugins, starts and manages your JEE webserver and jax-rs implementation.
+This module imports your configured plugins, starts and manages your JEE webserver and jax-rs implementation.
+
+## To use
+
+Simply add to the classpath
+
+Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-core</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-core:0.62'

micro-cors/build.gradle

@@ -16,7 +16,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-cors'
+		artifactId 'micro-cors'
 		version "$version" 
 
 

micro-cors/readme.md

@@ -10,10 +10,10 @@ Maven
 
      <dependency>
         <groupId>com.aol.microservices</groupId>  
-        <artifactId>microserver-cors</artifactId>
+        <artifactId>micro-cors</artifactId>
         <version>0.61</version>
      </dependency>
      
 Gradle
 
-    compile 'com.aol.microservices:microserver-cors:0.61'
+    compile 'com.aol.microservices:micro-cors:0.61'

micro-data/build.gradle

@@ -25,7 +25,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-data'
+		artifactId 'micro-data'
 		version "$version" 
 
 

micro-events/build.gradle

@@ -15,7 +15,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-events'
+		artifactId 'micro-events'
 		version "$version" 
 
 

micro-events/readme.md

@@ -10,13 +10,13 @@ Maven
 
      <dependency>
         <groupId>com.aol.microservices</groupId>  
-        <artifactId>microserver-events</artifactId>
+        <artifactId>micro-events</artifactId>
         <version>0.61</version>
      </dependency>
      
 Gradle
 
-    compile 'com.aol.microservices:microserver-events:0.61'
+    compile 'com.aol.microservices:micro-events:0.61'
 
 ### Depends on
 

micro-grizzly-with-jersey/build.gradle

@@ -18,7 +18,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-grizzly-with-jersey'
+		artifactId 'micro-grizzly-with-jersey'
 		version "$version" 
 
 

micro-grizzly-with-jersey/readme.md

@@ -1,3 +1,21 @@
 # Grizzly, Jersey and Microserver together
 
-Convenience module that packages Grizzly, Jersey and Microserver together
+[Example Grizzly & Jersey Apps](https://github.com/aol/micro-server/tree/master/micro-grizzly/src/test/java/app)
+
+Convenience module that packages Grizzly, Jersey and Microserver together
+
+## To use
+
+Simply add to the classpath
+
+Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-grizzly-with-jersey</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-grizzly-with-jersey:0.62'

micro-grizzly/build.gradle

@@ -20,7 +20,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-grizzly'
+		artifactId 'micro-grizzly'
 		version "$version" 
 
 

micro-grizzly/readme.md

@@ -1,3 +1,22 @@
 # Grizzly web server Plugin
 
-Plugin that allows the Grizzly Web server to be used with Microserver
+[Example Grizzly apps](https://github.com/aol/micro-server/tree/master/micro-grizzly/src/test/java/app)
+
+Plugin that allows the Grizzly Web server to be used with Microserver.
+
+
+## To use
+
+Simply add to the classpath
+
+Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-grizzly</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-grizzly:0.62'

micro-guava/build.gradle

@@ -18,7 +18,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-guava'
+		artifactId 'micro-guava'
 		version "$version" 
 
 

micro-guava/readme.md

@@ -1,6 +1,47 @@
 # Guava Plugin for Microserver
 
+[micro-guava example apps](https://github.com/aol/micro-server/tree/master/micro-guava/src/test/java/app)
+
 This plugin 
 
 1. Configures Jackson for Guava serialisation / deserialisation, so Guava types can be used as input and output to jax-rs Resources
-2. Configures a Guava EventBus as a Spring Bean (named microserverEventBus)  
+2. Configures a Guava EventBus as a Spring Bean (named microserverEventBus)  
+
+## To use
+
+Simply add to the classpath
+
+Maven 
+
+     <dependency>
+        <groupId>com.aol.microservices</groupId>  
+        <artifactId>micro-guava</artifactId>
+        <version>0.62</version>
+     </dependency>
+     
+Gradle
+
+    compile 'com.aol.microservices:micro-guava:0.62'
+
+
+# Example Guava Resource
+
+    @Rest
+    @Path("/status")
+    public class GuavaAppResource  {
+
+		@POST
+		@Produces("application/json")
+		@Path("/ping")
+		
+		public ImmutableList<String> ping( ImmutableGuavaEntity entity) {
+			return entity.getList();
+		}
+		@POST
+		@Produces("application/json")
+		@Path("/optional")
+		public Optional<String> optional(Jdk8Entity entity) {
+			return entity.getName();
+		}
+
+   }

micro-guava/src/test/java/app/guava/com/aol/micro/server/GuavaAppResource.java

@@ -1,26 +1,22 @@
 package app.guava.com.aol.micro.server;
 
-import java.util.List;
 import java.util.Optional;
 
-import javax.validation.constraints.NotNull;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.Produces;
 
-import org.springframework.stereotype.Component;
-
-import com.aol.micro.server.auto.discovery.RestResource;
+import com.aol.micro.server.auto.discovery.Rest;
 import com.google.common.collect.ImmutableList;
-@Component
+@Rest
 @Path("/status")
-public class GuavaAppResource implements RestResource {
+public class GuavaAppResource {
 
 	@POST
 	@Produces("application/json")
 	@Path("/ping")
 
-	public List ping( ImmutableGuavaEntity entity) {
+	public ImmutableList<String> ping( ImmutableGuavaEntity entity) {
 		return entity.getList();
 	}
 	@POST

micro-ip-tracker/build.gradle

@@ -14,7 +14,7 @@ modifyPom {
 		inceptionYear '2015'
 
 		groupId 'com.aol.microservices'
-		artifactId 'microserver-ip-tracker'
+		artifactId 'micro-ip-tracker'
 		version "$version"