Skip to content

Commit b66d46d

Browse files
Small touches to the readme
1 parent 3025628 commit b66d46d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@ This library can be added to a Go project to generate a
2424
timestamped log of events in a concurrent or distributed system.
2525
GoVector is compatible with Go 1.4+
2626

27-
* govec/ : Contains the Library and all its dependencies
28-
* example/ : Contains some examples instrumented with different features of GoVector
27+
* govec/ : Contains the Library and all its dependencies
28+
* govec/vclock : Pure vector clock library
29+
* govec/vrpc : Go's rpc with GoVector integration
30+
* example/ : Contains some examples instrumented with different features of GoVector
2931

3032
### Installation
3133

@@ -69,7 +71,12 @@ The following is a basic example of how this library can be used
6971
Logger.LogLocalEvent("Example Complete")
7072
}
7173
```
72-
For complete documentation and examples see GoVectors [GoDoc](https://godoc.org/github.com/DistributedClocks/GoVector/govec),
74+
For complete documentation and small examples see GoVectors [GoDoc](https://godoc.org/github.com/DistributedClocks/GoVector/govec),
75+
76+
### End to End Examples
77+
78+
* Client-Server GoVector insturmentation [Examples/ClientServer.go](example/ClientServer/ClientServer.go)
79+
* RPC Client-Server program [Examples/RpcClientServer.go](example/RpcClientServer/RpcClientServer.go)
7380

7481
### Motivation
7582

@@ -86,11 +93,7 @@ This produces the log "LogFile.txt" :
8693
MyProcess {"MyProcess":4}
8794
Example Complete
8895

89-
An executable example of a similar program can be found in
90-
[Examples/ClientServer.go](example/ClientServer/ClientServer.go)
9196

92-
An executable example of a RPC Client-Server program can be found in
93-
[Examples/RpcClientServer.go](example/RpcClientServer/RpcClientServer.go)
9497

9598

9699
Here is a sample output of the priority logger

0 commit comments

Comments
 (0)