diff --git a/README.md b/README.md index b56a394..f58b606 100644 --- a/README.md +++ b/README.md @@ -15,21 +15,26 @@ All client-side code is in the `index.js` file for easy inclusion in a web page. Run `npm run demo` to test the flow renderer in a browser. +Run `npm run build` to build a minimised version of the flow renderer. This will output the file `index.min.js`. + +IMPORTANT: The minified version of the flow renderer should be built before committing changes to the repository. + ## Usage Add the following script tag to your HTML file: ```html - + ``` _or wherever the script is located in your project_ Next, add a container element to your HTML file and call the `flowRenderer` function with the flow data and options. NOTE: flow-renderer is an ES Module and requires a modern browser to run. Script tags must have the `type="module"` attribute. -By default, the flow renderer will render the flow with `gridlines`, `images`, `labels` and `zoom` options enabled. +By default, the flow renderer will render the flow with `gridLines`, `images`, `labels`, `zoom`, `autoZoom`, and `autoScroll` enabled. +`linkLines` are disabled by default. -To operate the zoom, use the mouse wheel + Ctrl key. +To operate the zoom, use the mouse wheel + Ctrl or ⌘ key. To scroll the container vertically, use the mouse wheel without the Shift key. To scroll the container horizontally, use the mouse wheel + Shift key. @@ -42,7 +47,7 @@ To scroll the container horizontally, use the mouse wheel + Shift key ``` ```html - --> @@ -48,12 +47,12 @@