aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3b6ab91
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# Circular
+
+Circular is a stream abstraction designed for use with nom. It can expose the
+available data, a mutable slice of the available space, and it separates
+reading data from actually consuming it from the buffer.