Create README.md

Author: MrIceman

README.md

@@ -0,0 +1,38 @@
+# go-uml
+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
+and you won't find some functionalities yet such as
+
+- provide conditional flows
+
+# Example
+
+```
+ 	d := sequence.NewDiagram("user_starts_chatting")
+
+	client := "Client"
+	backend := "Backend"
+	db := "DynamoDB"
+
+	d.SetTitle("User initiates chat with another User")
+	d.AddParticipant(client)
+	d.AddParticipant(backend)
+	d.AddParticipant(db)
+
+	d.AddDirectionalEdge(client, backend, "PUT /chat/user/<TO_ID>")
+	d.AddDirectionalEdge(backend, db, "checks or create inbox for user")
+	d.AddDirectionalEdge(backend, client, "return chat meta data + chat secret")
+	d.AddDirectionalEdge(client, backend, "WS /joinchat/<CHAT_ID> payload: secret")
+	d.AddDirectionalEdge(backend, db, "compare inbox secret")
+	d.AddDirectionalEdge(backend, db, "set all unread messages to read")
+	d.AddDirectionalEdge(backend, db, "store connection ID for user")
+	d.AddDirectionalEdge(backend, client, "202 - You're good to go")
+	d.AddDirectionalEdge(client, backend, "WS /sendmessage/<CHAT_ID> payload: hello!")
+	d.AddDirectionalEdge(backend, db, "get connection ID for <TO_ID>")
+	d.AddDirectionalEdge(backend, backend, "notify <TO_ID> with connection ID if present")
+	d.AddDirectionalEdge(backend, db, "store message in chat")
+	d.AddDirectionalEdge(client, backend, "disconnect")
+	d.AddDirectionalEdge(backend, db, "remove connection ID for user")
+
+	d.Render()
+
+```