From 21b3c6b9e9c8de28cffa5856a5c04ee1eea27648 Mon Sep 17 00:00:00 2001
From: Stephen McQuay <stephen@mcquay.me>
Date: Sun, 2 Mar 2014 23:10:16 -0800
Subject: [PATCH] started readme

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 readme.md

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)
+```