Skip to content

Commit b9cbe9e

Browse files
committed
userBIsPartOfChat() rather than UserBIsPartOfChat() as it shouldn't be exported.
1 parent 5330450 commit b9cbe9e

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ and you won't find some functionalities yet such as
66

77
The generated diagram is saved as .PNG file
88

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.
9+
So far, you can create only sequence diagrams and add Participants, directional and non-directional Edges, labels for Edges and set a Title for the diagram.
1010
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).
1111

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
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](https://github.com/fogleman/gg) written 100% in Go
1313

1414
# How to install
1515

@@ -26,7 +26,7 @@ first
2626

2727
# Example
2828

29-
```
29+
```go
3030
d := sequence.NewDiagram("user_starts_chatting")
3131

3232
client := "Client"
@@ -55,7 +55,7 @@ first
5555
d.Render()
5656

5757
```
58-
Result PNG file:
58+
Resulting PNG file:
5959
![Sequence Diagram generated based on above code](./examples/user_starts_chatting.png)
6060

6161
Some more examples:

examples/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ import "github.com/mriceman/go-uml/sequence"
55
func main() {
66
userStartsChatting()
77
userBIsNotPartOfChat()
8-
UserBIsPartOfChat()
8+
userBIsPartOfChat()
99

1010
}
1111

12-
func UserBIsPartOfChat() {
12+
func userBIsPartOfChat() {
1313
d := sequence.NewDiagram("on_new_message_for_user_b")
1414

1515
usrA := "User A"

0 commit comments

Comments
 (0)