diff --git a/README.md b/README.md index 079bc5b..ecfcdd9 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,23 @@ # d3-dot-graph -This module provides [D3js](d3js) compatible library to parse and load files in graphviz [.dot](dot) (graph description language) format. +This module provides [D3js][d3js] compatible library to parse and load files in graphviz [DOT (.dot)][dot] (graph description language) format. ## why? -While working on Java Platform Module System migration projects coming with Java 9 (as of August 2017), I am havily using jdeps which is generating DOT (.dot) files. These are usually visualized using dot tool of graphviz. +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]. -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 visualization and interaction. + +## example + +See sample `summary.dot` file generated by [jdeps][jdeps] visualized using D3js][d3js] here: [index.html][example] + +![Sample .dot file generated by jdeps visualized using D3js](./docs/digraph.png) + +Inspired by [Mike Bostosck][mbostock] ## usage -Usage is identical with well known ´d3.json([url], [callback])´ or ´d3.csv([url], [callback])´. +Usage is identical with well known `d3.json([url], [callback])` or `d3.csv([url], [callback])`. ```html @@ -29,11 +37,11 @@ d3.dot("/path/to/graph.dot", function(error, graph) { ## parser -The parser was generated using [PEG.js](pegjs). The grammer is taken from here [cpettitt/graphlib-dot](https://github.com/cpettitt/graphlib-dot). Thanks to Chris Pettitt. +The parser was generated using [PEG.js][pegjs]. The grammer is taken from here [cpettitt/graphlib-dot](https://github.com/cpettitt/graphlib-dot). Thanks to Chris Pettitt. You can also use parser independently from loader and converter. -# build +## build ```shell npm install #install dependencies and build @@ -47,3 +55,8 @@ rollup -c -w (rollup --config --watch) #very convenient rolls the whenever sourc [d3js]: https://www.d3js.org [dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language) [pegjs]: https://pegjs.org +[jpms]: http://openjdk.java.net/projects/jigsaw/spec/sotms +[jdeps]: https://docs.oracle.com/javase/9/tools/jdeps.htm +[graphviz]: http://www.graphviz.org +[mbostosck]: http://bl.ocks.org/mbostock/1153292 +[example]: https://cdn.rawgit.com/gmamaladze/d3-dot-graph/cf08847e/example/index.html diff --git a/doc/digraph.png b/doc/digraph.png new file mode 100644 index 0000000..7ce5f15 Binary files /dev/null and b/doc/digraph.png differ