Skip to content

Commit 3f36537

Browse files
author
emilien
committed
fix readme
1 parent 8bf3e8e commit 3f36537

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A tool to build dependency graph for go programs based on dependency injection f
1212
https://github.com/google/wire/blob/main/_tutorial/main.go
1313

1414
## c4 plantuml component
15+
1516
```puml
1617
@startuml
1718
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Component.puml
@@ -29,6 +30,8 @@ Rel(main.Event, main.Greeter, main.Greeter)
2930
@enduml
3031
```
3132

33+
http://www.plantuml.com/plantuml/uml/RO_1QiGW48RlFeNDgO5klFJKOqFPInTAeUSmcmn6K2CwDYobxzvHaYvTUX3znfdlrplZHvidb3DHI4zAHLWxRMZEvvmmZeidzDIDYrF1WgVix27HPCrPzO-7jrBwEBqg1uamScde5nSMNsO2zmf1XYnAGXu20hMQY4C25omAqRCTZCSuF2_PJn0lzuxvGJPbQrhv9NvrzQOxHaGEsZfsR9ZBsb2Q96dcq4j0ESuGDKvovJz9NHgCrr9dVb3gclOsuEMJZxk-mYwlKDGWDR0-5i_LYh7gnBTuHtlps4edJ0aq_gNsshqb_pEvKIj-0000
34+
3235
## mermaid class
3336

3437
```mermaid
@@ -37,8 +40,6 @@ main_Greeter ..> main_Message
3740
main_Event ..> main_Greeter
3841
```
3942

40-
http://www.plantuml.com/plantuml/uml/RO_1QiGW48RlFeNDgO5klFJKOqFPInTAeUSmcmn6K2CwDYobxzvHaYvTUX3znfdlrplZHvidb3DHI4zAHLWxRMZEvvmmZeidzDIDYrF1WgVix27HPCrPzO-7jrBwEBqg1uamScde5nSMNsO2zmf1XYnAGXu20hMQY4C25omAqRCTZCSuF2_PJn0lzuxvGJPbQrhv9NvrzQOxHaGEsZfsR9ZBsb2Q96dcq4j0ESuGDKvovJz9NHgCrr9dVb3gclOsuEMJZxk-mYwlKDGWDR0-5i_LYh7gnBTuHtlps4edJ0aq_gNsshqb_pEvKIj-0000
41-
4243
# Installation
4344

4445
`go install github.com/emilien-puget/go-dependency-graph@latest`
@@ -51,14 +52,17 @@ http://www.plantuml.com/plantuml/uml/RO_1QiGW48RlFeNDgO5klFJKOqFPInTAeUSmcmn6K2C
5152

5253
Available generator are as follows
5354

54-
- `c4_plantuml_component`, the default value, more information about that format here : https://github.com/plantuml-stdlib/C4-PlantUML
55+
- `c4_plantuml_component`, the default value, more information about that format
56+
here : https://github.com/plantuml-stdlib/C4-PlantUML
5557
- `json`, the struct `parse.AstSchema` encoded in JSON
56-
- `mermaid_class`, a class diagram using mermaid syntax https://mermaid-js.github.io/mermaid/#/classDiagram?id=class-diagrams
58+
- `mermaid_class`, a class diagram using mermaid
59+
syntax https://mermaid-js.github.io/mermaid/#/classDiagram?id=class-diagrams
5760

5861
### With the result written to a file
5962

6063
`go-dependency-graph --project=<path to project> --result=<result file>`
6164

6265
### With the result piped
66+
6367
`go-dependency-graph --project=<path to project> > <piped>`
6468

0 commit comments

Comments
 (0)