diff --git a/README.md b/README.md index 74619c2..9df97dc 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # d3-dot-graph -This module provides [D3js][d3js] compatible library to parse and load files in graphviz [DOT (.dot)][dot] (graph description language) format. +This module provides [D3js][d3js] compatible library to parse and load files in [graphviz][graphviz] [DOT (.dot)][dot] (graph description language) format. ## why? -While working on [Java Platform Module System][jpms] migration projects coming with Java 9 (as of August 2017), I am havily using [jdeps][jdeps] which is generating [DOT (.dot)][dot] files. These are usually visualized using dot tool of [graphviz][graphviz]. +While working on [Java Platform Module System][jpms] migration projects coming with Java 9 (as of August 2017), I am heavily using [jdeps][jdeps] which is generating [DOT (.dot)][dot] files. These are usually visualised using dot tool of [graphviz][graphviz]. -In most cases it is enough, but I wanted to have nicer d3js visualization and interaction. +In most cases it is enough, but I wanted to have nicer [D3js][d3js] visualisation and interaction. ## example -See sample `summary.dot` file generated by [jdeps][jdeps] visualized using [D3js][d3js] here: [index.html][example] +See sample `summary.dot` file generated by [jdeps][jdeps] visualised using [D3js][d3js] here: [index.html][example] -![](doc/digraph.png "Sample .dot file generated by jdeps visualized using D3js") +![](doc/digraph.png "Sample .dot file generated by jdeps visualised using D3js") -Inspired by Mike Bostosck's [Mobile Patent Suits][mbostock] +Inspired by Mike Bostock's [Mobile Patent Suits][mbostock] ## usage