diff --git a/README.md b/README.md index c143e5a..4e98207 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,15 @@ ## Usage +You need to host a local http server for providing the definition files. Please create a dedicated directory @ `localhost` for that purpose. +### Prerequisites + First, you need to generate the visualisation data: ``` -cabal run workflow-visualiser -- +cabal run workflow-visualiser -- --all ``` -Copy the contents of `target.json` and paste them as the value of the variable `workflow` into the first line of [`editor.js`](./editor.js#L1). - -Open `editor.html` in order to display the graph. \ No newline at end of file +Afterwards you can run your server and listen on port `8080`. +### Open Editor +Open `editor.html` in your browser and select the desired workflow via the file menu. \ No newline at end of file