From 3f47512208a92df8937fc47ab6a3e4cb6acd14bf Mon Sep 17 00:00:00 2001
From: Mark Canlas <github@htmlism.com>
Date: Fri, 22 Mar 2024 11:19:33 +0100
Subject: [PATCH] improve mermaid and plantuml documentation

---
 README.md        | 21 +++------------------
 docs/mermaid.md  | 16 ++++++++++++++++
 docs/plantuml.md | 19 +++++++++++++++++++
 3 files changed, 38 insertions(+), 18 deletions(-)
 create mode 100644 docs/mermaid.md
 create mode 100644 docs/plantuml.md

diff --git a/README.md b/README.md
index 9c87eb35..08b0919a 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,10 @@
 # temporal-diagrams
 A Scala DSL for generating diagram variants
 
-## Features (v2)
+## Supported target languages
 
-- Supports PlantUML
-- Supports Mermaid
-- Uses `cats` style encoding, derivation, and combinators
-
-## Viewing PlantUML
-
-### With Google Chrome
-
-Install the extension [PlantUML Viewer](https://chrome.google.com/webstore/detail/plantuml-viewer/legbfeljfbjgfifnkmpoajgpgejojooj?hl=en)
-
-When viewing on GitHub, be sure to access the "raw" version of the file (as plain text, outside of the GitHub UI)
-
-### With IntelliJ
-
-Install the plugin [PlantUML Integration](https://plugins.jetbrains.com/plugin/7017-plantuml-integration)
+- :white_check_mark: [Mermaid](docs/mermaid.md)
+- :white_check_mark: [PlantUML](docs/plantuml.md)
 
 ## See also
 
@@ -43,6 +30,4 @@ PLANTUML_LIMIT_SIZE=8192 sbt run
 
 ## Elsewhere
 
-- [Mermaid](http://mermaid.js.org/)
-- [PlantUML](https://plantuml.com/)
 - https://crashedmind.github.io/PlantUMLHitchhikersGuide/layout/layout.html
diff --git a/docs/mermaid.md b/docs/mermaid.md
new file mode 100644
index 00000000..4d22bbbe
--- /dev/null
+++ b/docs/mermaid.md
@@ -0,0 +1,16 @@
+# Mermaid support
+
+[Mermaid](http://mermaid.js.org/) is a DSL for different types of diagrams. Notably, it can be written in GitHub Markdown documents and rendered automatically inline
+
+## Supported diagram types
+
+- :white_check_mark: [Flowchart](https://mermaid.js.org/syntax/flowchart.html#styling-and-classes)
+  - :white_check_mark: Diagram direction 
+  - :white_check_mark: Node shapes
+  - :white_check_mark: Links between nodes
+    - :white_check_mark: Multi-source links
+    - :white_check_mark: Chained links
+    - :white_check_mark: Arrow styling
+  - :white_check_mark: Subgraphs
+  - :white_check_mark: Link styling
+  - :white_check_mark: Node styling by ID
diff --git a/docs/plantuml.md b/docs/plantuml.md
new file mode 100644
index 00000000..6805070f
--- /dev/null
+++ b/docs/plantuml.md
@@ -0,0 +1,19 @@
+# PlantUML support
+
+[PlantUML](https://plantuml.com/) is a DSL for different types of diagrams
+
+## Supported diagram types
+
+- :white_check_mark: [Sequence diagram](https://plantuml.com/sequence-diagram) 
+
+## Viewing PlantUML
+
+### With Google Chrome
+
+Install the extension [PlantUML Viewer](https://chrome.google.com/webstore/detail/plantuml-viewer/legbfeljfbjgfifnkmpoajgpgejojooj?hl=en)
+
+When viewing on GitHub, be sure to access the "raw" version of the file (as plain text, outside of the GitHub UI)
+
+### With IntelliJ
+
+Install the plugin [PlantUML Integration](https://plugins.jetbrains.com/plugin/7017-plantuml-integration)