Version Change Documentation

README.md

@@ -26,15 +26,15 @@ Stable:
 		<dependency>
 			<groupId>com.strategicgains</groupId>
 			<artifactId>RestExpress</artifactId>
-			<version>0.10.5</version>
+			<version>0.11.0</version>
 		</dependency>
 ```
 Development:
 ```xml
 		<dependency>
 			<groupId>com.strategicgains</groupId>
 			<artifactId>RestExpress</artifactId>
-			<version>0.10.6-SNAPSHOT</version>
+			<version>0.11.1-SNAPSHOT</version>
 		</dependency>
 ```
 Or download the jar directly from: http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22RestExpress%22
@@ -80,9 +80,18 @@ Please see the Kickstart application in examples/kickstart for a complete, runni
 ===================================================================================================
 Change History/Release Notes:
 ---------------------------------------------------------------------------------------------------
-Release 0.10.6-SNAPSHOT - in 'master' branch
+Release 0.11.1-SNAPSHOT - in 'master' branch
 ------------------------
 
+Release 0.11.0-SNAPSHOT - 09 Jan 2015
+-----------------------
+* Upgraded Netty version from 3.9.5.Final to 4.0.24.Final
+* Refactored Pipeline to accommodate Netty upgrade.
+* Refactored Bootstrap to accommodate Netty upgrade.
+* Added in Unit Tests to test RestExpress' ability to compress and decompress data.
+
+* KNOWN ISSUE - Controllers cannot return ReferenceCounted objects that also exist in the Request object.  This will cause the transaction to fail with an IllegalReferenceCountException.  If a ReferenceCounted object needs to be returned, a separate copy of the object will need to be made (some classes, such as ByteBuf, have a .copy() method to facilitate this).
+
 Release 0.10.5 - 2 Dec 2014
 -----------------------
 * Changed FilterComponent.setValue(String) signature to setValue(Object).

UPDATE.md

@@ -0,0 +1,11 @@
+Guide to the Netty 4 Upgrade of RestExpress (v. 0.11.0)
+
+The Netty Project made several semantical revisions to the naming conventions for its classes.  These changes where inherited by the RestExpress Project in its latest update, and will most likely cause breaking changes to most applications using RestExpress. This document is a guide to updating applications to the latest version of RestExpress.  As previously stated, the changes that effect applications using RestExpress are mainly semantical. Therefor, most (if not all) of the fixes are a simple refactorings. The largest change to the project was the organization change, which the package names of Netty classes reflect. The organization of Netty has been changed from “org.jboss.netty” to “io.netty”
+
+org.jboss.netty.* → io.netty.*
+
+This will be the cause of most of the import errors that applications will experience during the upgrade.  Additionally, Netty 4 has changed the naming conventions of some of their getters by excluding the “get” in the method name. This convention shift can be demonstrated with an example of the HttpResponseStatus Netty class:
+
+httpResponseStatus.getCode() → httpResponseStatus.code()
+
+Most “methodNotFound” errors for getters that applications will experience during the upgrade will be the result of this conventions change.  Any application that is also using either Plug-in Express (0.2.6 or earlier) or Hyper Express (2.2 or earlier) will have to upgrade to the latest version of Plug-in Express/Hyper Express. Older versions of Plug-in Express/Hyper Express are incompatible with the latest version of RestExpress. In addition, any dependency that directly references older versions of Netty (3.x.x or older) or RestExpress (0.10.5 or older) will need to be upgraded. This is due to the semantical differences between Netty 3.x.x and 4.x.x – therefor, this document can be used to upgrade those dependancies.