From cd3560fc4371fc3ece23bf212a5d9ac1acc04304 Mon Sep 17 00:00:00 2001 From: gmamaladze Date: Fri, 1 Sep 2017 15:54:10 +0200 Subject: [PATCH] updated readme. --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ecfcdd9..74619c2 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,18 @@ In most cases it is enough, but I wanted to have nicer d3js visualization and in ## 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] visualized using [D3js][d3js] here: [index.html][example] -![Sample .dot file generated by jdeps visualized using D3js](./docs/digraph.png) +![](doc/digraph.png "Sample .dot file generated by jdeps visualized using D3js") -Inspired by [Mike Bostosck][mbostock] +Inspired by Mike Bostosck's [Mobile Patent Suits][mbostock] ## usage +```js +d3.dot(url, callback); +``` + Usage is identical with well known `d3.json([url], [callback])` or `d3.csv([url], [callback])`. ```html @@ -50,7 +54,6 @@ npm run build #generate parser, and rollup rollup -c -w (rollup --config --watch) #very convenient rolls the whenever sources are changed ``` -## notes [d3js]: https://www.d3js.org [dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language) @@ -58,5 +61,5 @@ rollup -c -w (rollup --config --watch) #very convenient rolls the whenever sourc [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 +[mbostock]: http://bl.ocks.org/mbostock/1153292 [example]: https://cdn.rawgit.com/gmamaladze/d3-dot-graph/cf08847e/example/index.html