add a readme

msays2000 · Jul 4, 2020 · 13441b8 · 13441b8
1 parent 3e8571b
commit 13441b8
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
-# ring
+# ring
+
+RingChannel uses two channels input and output in a way that never blocks the input.
+Specifically, if a new value gets added to a RingChannel's input when its buffer is full then the oldest
+value in the output channel gets removed to make room (just like a standard ring-buffer).