aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Geoffroy Couprie <geo.couprie@gmail.com>2017-05-04 21:31:37 +0200
committerLibravatar Geoffroy Couprie <geo.couprie@gmail.com>2017-05-04 21:31:37 +0200
commitf15987b34a554ee7db1df643cebe8be9e0317e38 (patch)
tree9892ae25e9020a11b7f42f8583df05f610b0db40 /README.md
downloadcircular-f15987b34a554ee7db1df643cebe8be9e0317e38.tar.gz
circular-f15987b34a554ee7db1df643cebe8be9e0317e38.tar.bz2
circular-f15987b34a554ee7db1df643cebe8be9e0317e38.zip
initial commit
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.