Add documentation, comments, rename to DotRenderer

README.md

@@ -65,11 +65,14 @@ import scala.collection.immutable.Queue
 
 val renderer = Renderer(
   renderingOptions = RenderingOptions(density = 75),
-  directory = Paths.get("images", "usage"),
-  format = "png" // Or "svg", "ps" and others supported by dot
+  directory = Paths.get("images", "usage")
 )
 ```
 
+You can also pass a `format` parameter as a String to the `Renderer` constructor
+to specify the format you require. The default is `png`. You can specify any
+file type supported by `dot -T`.
+
 There are two ways to use it:
 
 ```scala

core/src/main/scala/reftree/render/ImageRenderer.scala → core/src/main/scala/reftree/render/DotRenderer.scala

@@ -7,9 +7,10 @@ import uk.co.turingatemyhamster.graphvizs.exec._
 
 import scala.sys.process.{Process, BasicIO}
 
-object ImageRenderer {
+object DotRenderer {
   def render(graph: Graph, output: Path,
-    options: RenderingOptions, format: String): Unit = {
+    options: RenderingOptions, format: String
+  ): Unit = {
     val args = Seq(
       "-K", "dot",
       "-T", format,

core/src/main/scala/reftree/render/Renderer.scala

@@ -20,8 +20,14 @@ import reftree.svg.SvgGraphAnimation
  *
  *   val renderer = Renderer(
  *     renderingOptions = RenderingOptions(density = 75),
+ *     directory = Paths.get("images", "usage")
+ *   )
+ *
+ *   // With custom output format
+ *   val renderer = Renderer(
+ *     renderingOptions = RenderingOptions(density = 75),
  *     directory = Paths.get("images", "usage"),
- *     format = "jpg"
+ *     format = "ps" // Or any other format that compatible with dot -T
  *   )
  *
  *   // Conventional usage
@@ -52,11 +58,12 @@ case class Renderer(
   /** Render a diagram to a file with the given name (do not include the extension) */
   def render(name: String, diagram: Diagram): Unit = {
     val graph = Graphs.graph(renderingOptions)(diagram)
-    ImageRenderer.render(
+    DotRenderer.render(
       graph,
       directory.resolve(s"$name.$format"),
       renderingOptions,
-      format)
+      format
+    )
   }
 
   /** Render an animation to a GIF file with the given name (do not include the extension) */

demo/src/main/tut/README.md

@@ -69,6 +69,10 @@ val renderer = Renderer(
 )
 ```
 
+You can also pass a `format` parameter as a String to the `Renderer` constructor
+to specify the format you require. The default is `png`. You can specify any
+file type supported by `dot -T`.
+
 There are two ways to use it:
 
 ```tut:silent