From 6ae6bb4da5a77ea0c409c56414527bc4d495b6a5 Mon Sep 17 00:00:00 2001 From: Stefan Weiberg Date: Mon, 13 May 2024 09:26:05 +0200 Subject: [PATCH] add png option to readme --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6e6b6bd..19c1c6a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # OpenProject Workflow Visualiser This script parses a downloaded HTML of the Administration>Workflow page in OpenProject and extracts the default workflow of the previously selected role and type as a Mermaid stateDiagram-v2. It's recommended to download the workflow page with the checkmark set for only showing states used by the type. +In case you have mermaid-cli installed on your system and mmdc in your '$PATH', you can use the '-o' option to output a PNG rendering of your diagram. This option won't output a markdown representation. + ## Example (role: Project Manager, type: Epic) In this example the role is allowed to act on all states or the work package.