Elaborate "Usage" in README

[mr-niels-christensen]

This project sounds great, but while the "Usage" section may be obvious to a bower/require/D3 veteran, I'm mystified. It'd be great if you could clarify some of the below questions!

Where should the following JSON be stored (and why)? Are the paths generally useful or should they be modified in every project? I was considering a .bowerrc with "directory": "src/components" or similar - would it be simple to change the paths to that configuration? Does these path need to be specified before doing bower install graphviz-d3-renderer --save?

paths: {
    d3: '/bower_components/d3/d3',
    "dot-checker": '/bower_components/graphviz-d3-renderer/dist/dot-checker',
    "layout-worker": '/bower_components/graphviz-d3-renderer/dist/layout-worker',
    worker: '/bower_components/requirejs-web-workers/src/worker'
  }

Also: Could you list the scripts loaded before the JS code beginning with require(["renderer"]? Or even better, put a working JS/HTML example in the repo?

[mstefaniuk]

@mr-niels-christensen I know that usage section is not too elaborated. For quick workaround I suggest to check Graphviz fiddling website or its source on Github.

[mr-niels-christensen]

Will do. Thanks!

On Fri, Oct 9, 2015 at 11:41 AM Marcin Stefaniuk [email protected]
wrote:

@mr-niels-christensen https://github.com/mr-niels-christensen I know
that usage section is not too elaborated. For quick workaround I suggest to
check Graphviz fiddling website http://graphviz.it or its source on
Github http:///mstefaniuk/graphviz.it.

—
Reply to this email directly or view it on GitHub
#5 (comment)
.

[mstefaniuk]

Readme should cover:

• how to install
• how to modify animations