Update the README.md file and changes to the plugin packaging

Author: Alex Davies-Moore

README.md

@@ -1,2 +1,66 @@
-# flit
-Twitch Twirp RPC implementation for Java
+# Flit - Twirp RPC Generator Framework
+
+This project is a generator for the [Twitch TV Twirp](https://github.com/twitchtv/twirp "Twitch TV Twirp") RPC
+framework.
+
+It supports the generation of Java based servers with the following flavours supported:
+
+    + [Spring Boot/Spring MVC](https://spring.io/projects/spring-boot "Spring Boot")
+    + [Undertow](http://undertow.io/ "Undertow")
+
+## Building & Running
+
+### Requirements
+
+The build has been tested with [Oracle's JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html "JDK Downloads") (version 1.8)
+
+The build uses gradle to generate the artifacts. No installation is required as the project uses the
+[gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html "gradle wrapper") setup.
+
+For testing you will need an installation of the [protocol buffers compiler](https://github.com/google/protobuf/releases "protobuf releases").
+
+### Modules
+
+The project is split into the following modules:
+
+| Module            |   Description                                         |
+|:------------------|:------------------------------------------------------|
+| `plugin`          | The `protoc` plugin                                   |
+| `runtime:core`    | Core functionality required by generated code         |
+| `runtime:spring`  | Runtime library for Spring MVC/Boot servers           |
+| `runtime:undertow`| Runtime library for Undertow servers                  |
+
+
+### Build
+
+To build the various components, run the following:
+
+    git clone git@github.com:devork/flit.git
+    cd flit
+    ./gradlew clean build pack
+
+### Installation
+
+Currently, the run script only supports *nix but the run script should be fairly easy to migrate to windows.
+
+After building:
+
+    cp plugin/build/package/flit-plugin.zip /usr/local/bin
+    cd /usr/local/bin
+    unzip flit-plugin.zip
+    chmod +x protoc-gen-flit
+
+## Running
+
+The plugin is executed as part of a protoc compilation step:
+
+    protoc --proto_path=. --java_out=../java --flit_out=target=server,type=undertow:../java ./haberdasher.proto
+
+### Options
+
+The flit plugin accepts the following plugin parameters:
+
+| Name          | Required  | Type                          | Description                                               |
+|:--------------|:---------:|:------------------------------|:----------------------------------------------------------|
+| `target`      | Y         | `enum[server]`                | The type of target to generate e.g. server, client etc    |
+| `type`        | Y         | `enum[spring|undertow|boot]`  | Type of target to generate                                |

plugin/build.gradle

@@ -16,7 +16,9 @@ group 'com.flit'
 
 sourceCompatibility = 1.8
 
-version = "${project.version}+${project.scm.tstamp}"
+if (!(project.hasProperty("release") && project.properties['release'] == "true")) {
+    project.version += ".snapshot." + project.scm.tstamp
+}
 
 shadowJar {
     manifest {
@@ -33,7 +35,6 @@ repositories {
 dependencies {
     compile 'com.google.guava:guava:25.1-jre'
     compile 'org.slf4j:slf4j-api:1.7.25'
-    compile 'org.codehaus.janino:janino:3.0.6'
     compile 'ch.qos.logback:logback-classic:1.2.3'
     compile 'commons-io:commons-io:2.5'
     compile 'com.google.protobuf:protobuf-java:3.5.1'
@@ -47,3 +48,18 @@ dependencies {
 
 shadowJar.dependsOn build
 
+task pack(type: Zip) {
+
+    archiveName = "flit-plugin.zip"
+    destinationDir = file("${buildDir}/package")
+
+    from("${buildDir}/libs") {
+        include "plugin-*-all.jar"
+    }
+
+    from("${projectDir}/src/main/shell") {
+        include("*")
+    }
+}
+
+pack.dependsOn shadowJar