diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..7921250 --- /dev/null +++ b/readme.md @@ -0,0 +1,18 @@ +bandwidth +========= + +`bandwidth` is a little package to be used in collecting and reporting on bandwidth numbers. + +It is intended to be used as such: + + +```go + // report on 1, 10, 60 second intervals, update every 100 milliseconds + bw, _ := NewBandwidth([]int{1, 10, 60}, 100*time.Millisecond) + go bw.Run() + bw.AddRx <- 10 + bw.AddTx <- 10 + time.Sleep(1 * time.Second) + log.Printf("%+v", <-bw.Rx) + log.Printf("%+v", <-bw.Tx) +```