Skip to content

Commit f77965b

Browse files
committed
Merge remote-tracking branch 'origin/master'
2 parents 510c45e + 59ce6b7 commit f77965b

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# go-uml
2-
Just a little tool to create UML Diagrams built in Go. You can use it to build simple sequence diagrams, however, this project is still under development
2+
Just a little tool to create UML Diagrams built in Go. You can use it already to build simple sequence diagrams, however, this project is still under development
33
and you won't find some functionalities yet such as
44

55
- provide conditional flows
66

7+
The generated diagram is saved as .PNG file
8+
9+
So far, you can create only sequence diagrams and add Participants, directional and undirectional Edges, labels for Edges and set a Title for the diagram.
10+
I'll be updating this repository whenever I need the tool to support more functionality, feel free to create an Issue with a feature request. Since I just started this project, contributing should also be quite easy (I appreciate any contribution).
11+
12+
You don't need to download any dependencies such as plantUML or Graphviz, which is what most of the tools out there require and what was also my motivation to start this project. go-uml is using a 2D graphics engine written 100% in Go https://github.com/fogleman/gg
13+
714
# Example
815

916
```
@@ -37,4 +44,4 @@ and you won't find some functionalities yet such as
3744
3845
```
3946
Result PNG file:
40-
![image description](./examples/user_starts_chatting.png)
47+
![image description](./examples/user_starts_chatting.png)

0 commit comments

Comments
 (0)