From 30b1e6ec56d3d6d7e0061e47faf054fd689a8c3d Mon Sep 17 00:00:00 2001
From: Stephen McQuay <stephen@mcquay.me>
Date: Sun, 29 Dec 2013 01:03:07 -0800
Subject: [PATCH] added readme

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

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4538cd9
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,12 @@
+ostat
+=====
+
+ostat is a go package that implements the efficient, accurate, and stable
+calculation of [online](http://en.wikipedia.org/wiki/Online_algorithm)
+statistical quantities. More info on what is being implemented here can be
+found on
+[wikipedia](http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Online_algorithm)
+
+The algorithm comes from [*The Art of Computer Programing*, vol 2 by Knuth](http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#cite_note-5).
+
+For documentation please refer to `ostat_test.go`.