documentation updates

Author: UnquietCode

Documentation.java

@@ -107,11 +107,25 @@
     .setReturnType(String class)
 
 // Generate class names which are condensed at the expense of
-// being mangled and not as readable by a human. This is
+// being mangled and not as readable by humans. This is
 // useful if you have a complicated descriptor which creates
-// class names too long to be compiled.  (optional, disabled by default)
+// class names too long to be compiled.  (disabled by default)
     .enableCondensedClassNames()
 
+// Provide a custom name generator instance, to be consulted
+// when creating the generated source code.
+//
+// The `DefaultNameGenerator` implementation will leave names
+// as they are. A more compact form can be achieved by using
+// the `HashedNameGenerator`, which will try to shorten names
+// as much as possible.
+	.useCustomNameGenerator(NameGenerator generator)
+
+// Disable the printing of timestamps in the generated source
+// code. This will eliminate changes between successive executions
+// so long as the same version of the tool is used each time.
+	.disableTimestamps()
+
 // Complete the finished descriptor, returning a new 
 // `Descriptor` object. (**required**)
 .build()

README.md

@@ -56,8 +56,10 @@ composeEmail()
 
 ### [Getting Started](https://github.com/UnquietCode/Flapi/wiki/Getting-Started)
 If you are using Maven (or Gradle, or Ivy) you can download and install to your local repo, or include the following
-repository and dependency in your POM file:
-```
+repository and dependency in your build script:
+
+#### Maven
+```xml
 <repository>
   <id>uqc</id>
   <name>UnquietCode Repository</name>
@@ -73,13 +75,31 @@ repository and dependency in your POM file:
   <scope>test</scope>
 </dependency>
 ```
-In a test, define your `Descriptor` object and output the generated source code. (The
+
+#### Gradle
+```groovy
+repositories {
+  maven {
+    url 'http://www.unquietcode.com/maven/releases'
+  }
+}
+
+...
+
+dependencies {
+  testCompile 'unquietcode.tools.flapi:flapi:0.6.1'
+}
+```
+
+In a test define your `Descriptor` object and output the generated source code. (The
 [Pizza Builder](https://github.com/UnquietCode/Flapi/wiki/Pizza-Builder-Example)
 example is a simple descriptor you can start with.) You can also make use of the
 [maven plugin](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin) to
 perform the code generation.
 
-At the time of writing, the project builds fine in JDK 6 and 7. However, please note that the automated builds are no longer being run against JDK 6.
+At the time of writing, the project builds fine in JDK 6 and 7. However, please note that
+the automated builds are no longer being run against JDK 6.
+
 
 ### Additional Resources