sander/d3-dot-graph
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated readme.

Browse source
This commit is contained in:
gmamaladze 2017-09-01 15:54:10 +02:00
parent 6ca1ad8f61
commit cd3560fc43
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -9,14 +9,18 @@ In most cases it is enough, but I wanted to have nicer d3js visualization and in
## example ## 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 ## usage
```js
d3.dot(url, callback);
```
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 ```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 rollup -c -w (rollup --config --watch) #very convenient rolls the whenever sources are changed
``` ```
## notes
[d3js]: https://www.d3js.org [d3js]: https://www.d3js.org
[dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language) [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 [jpms]: http://openjdk.java.net/projects/jigsaw/spec/sotms
[jdeps]: https://docs.oracle.com/javase/9/tools/jdeps.htm [jdeps]: https://docs.oracle.com/javase/9/tools/jdeps.htm
[graphviz]: http://www.graphviz.org [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 [example]: https://cdn.rawgit.com/gmamaladze/d3-dot-graph/cf08847e/example/index.html