updated generic readme

build.gradle

@@ -8,6 +8,8 @@ plugins {
 	id 'net.saliman.cobertura' version '2.2.6'
 	id 'co.riiid.gradle' version '0.4.2'
 
+	id "com.github.johnrengelman.shadow" version "1.2.4"
+
 	id "synapticloop.copyrightr" version "1.1.2"
 	id "synapticloop.documentr" version "2.9.0"
 }
@@ -30,10 +32,21 @@ repositories {
 	jcenter()
 }
 
+configurations {
+	shadow
+}
+
 dependencies {
 	runtime 'synapticloop:routemaster:2.1.0'
 
 	compile 'synapticloop:routemaster:2.1.0'
+
+	shadow 'synapticloop:templar:1.4.4'
+}
+
+shadowJar {
+	classifier = ''
+	configurations = [project.configurations.shadow]
 }
 
 github {
@@ -42,9 +55,12 @@ github {
 	if(System.getenv('GITHUB_TOKEN')) {
 		token = System.getenv('GITHUB_TOKEN')
 	}
+
 	tagName = version
 	name = version
 	assets = [
 		'build/libs/' + archivesBaseName + '-' + version + '.jar',
 	]
 }
+
+build.finalizedBy(shadowJar) 

src/docs/readme-00.md

@@ -3,6 +3,12 @@
 This is an example module that offers additional, modular support for [synapticloop routemaster](https://github.com/synapticloop/routemaster).
 
 Routemaster modules can be automatically loaded from the `modules` directory that 
+can automatically provide:
+
+ - Handlers
+ - Configuration options
+ - RESTful routes
+ - static routes
 
 # Creating a new module
 

src/docs/readme-01.md

@@ -1,3 +1,14 @@
+
+## Including dependencies in the module
+
+Within the `build.gradle` file a `shadow` configuration is defined.  Any dependencies 
+that you wish to include in the final module **MUST** be listed here.  
+
+See the `configurations`, `dependencies` and the `shadowJat` sections in the 
+`build.gradle` file above.
+
+> **WARNING**: if multiple modules are including different versions of jar dependencies, then the order in which that these will be picked up by the class loader is undefined.
+
 ### File: `settings.gradle`
 
 You will also want to change the `settings.gradle` file:

src/main/java/synapticloop/nanohttpd/handler/TemplarHandler.java

@@ -24,7 +24,6 @@
 import java.util.Map;
 
 import synapticloop.nanohttpd.utils.HttpUtils;
-import synapticloop.nanohttpd.utils.MimeTypeMapper;
 import synapticloop.templar.Parser;
 import synapticloop.templar.exception.ParseException;
 import synapticloop.templar.exception.RenderException;