Skip to content

Commit 62c2129

Browse files
Readme update
1 parent b66d46d commit 62c2129

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ GoVector is a vector clock logging library written in Go. The [vector
1111
clock algorithm](https://en.wikipedia.org/wiki/Vector_clock) is used
1212
to order events in distributed systems in the absence of a centralized
1313
clock. GoVector implements the vector clock algorithm and provides
14-
feature rich logging, and encoding infrastructure. Vector clock events
14+
feature rich logging, and encoding infrastructure.
15+
16+
Vector clock events
1517
are generated using 3 key functions `PrepareSend`, `UnpackReceive`,
1618
and `LogLocalEvent`. PrepareSend encodes messages for network
1719
transport, updates GoVectors local time, and logs a sending event.
@@ -80,9 +82,13 @@ For complete documentation and small examples see GoVectors [GoDoc](https://godo
8082

8183
### Motivation
8284

83-
### Output
85+
GoVector was initially developed as a pedagogical tool for students attending UBC's computer science course on distributed systems (CPSC 416). Students new to the development of distributed systems can reason about event orderings by visualizing their executions with [ShiViz](http://bestchai.bitbucket.io/shiviz/). Furthermore GoVectors marshaling functionality reduces student effort in writing networking code which is largely boiler plate.
86+
87+
As a result of student requests GoVector transformed into a general purpose logging tool. Additional features include optimized IO, priority logging, [TSViz](https://bestchai.bitbucket.io/tsviz/) compatibility and RPC instrumentation.
88+
89+
### Output Example
8490

85-
This produces the log "LogFile.txt" :
91+
The source code from the useage example produces the following log into a file named "LogFile.txt" :
8692

8793
MyProcess {"MyProcess":1}
8894
Initialization Complete

0 commit comments

Comments
 (0)