Skip to content

Commit f33b8d3

Browse files
committed
doc: README bump
1 parent 746d0c0 commit f33b8d3

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# Layercake tool
22

3+
This tool takes graph definitions in CSV/TSV format and generates various graph formats for rendering.
4+
Export to,
5+
6+
- PlantUML
7+
- Graphviz / dot
8+
- Mermaid
9+
- GML (Graph Modeling Language)
10+
11+
Custom renders can be added using [Handlebars](https://handlebarsjs.com/) templates via [handlebars-rust](https://docs.rs/handlebars/latest/handlebars/).
12+
313
## Installation
414

515
### MacOS
@@ -49,20 +59,20 @@ cargo run -- -p sample/kvm_control_flow_plan.yaml
4959
_This tool only outputs text files, the following images are rendered using other tools._
5060

5161
### GML rendered with Gephi
52-
5362
Sample control for for virtualized x86 architecture, output to GML and rendered using Gephi.
5463

5564
![Sample](images/sample-gml-gephi.png)
5665

5766
### PlantUML rendered
67+
Sample control for for virtualized x86 architecture, output rendered using [PlantUML](https://plantuml.com/).
5868

5969
![Sample](images/kvm-plantuml.svg)
6070

61-
Sample control for for virtualized x86 architecture, output rendered using [PlantUML](https://plantuml.com/).
62-
6371
### Graphviz rendered
72+
Sample attack tree from [Kelly Shortridge's Security Descision Trees with Graphviz](https://kellyshortridge.com/blog/posts/security-decision-trees-with-graphviz/) output rendered using [Graphviz](https://graphviz.org/)
6473

6574
![Sample](images/attack-tree.svg)
6675

67-
Sample attack tree from [Kelly Shortridge's Security Descision Trees with Graphviz](https://kellyshortridge.com/blog/posts/security-decision-trees-with-graphviz/) output rendered using [Graphviz](https://graphviz.org/)
76+
77+
6878

0 commit comments

Comments
 (0)