aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2019-10-27 08:18:50 -0400
committerJesse Luehrs <doy@tozt.net>2019-10-27 08:18:50 -0400
commit649450762eff2d71371e176534fbe64752a3284e (patch)
tree2364d615f0642fc11ade82bf1cb8ee6bd2f385ea /README.md
parent7f2186ef75947e456cba122f511f2f5725e3eef6 (diff)
downloadttyrec-649450762eff2d71371e176534fbe64752a3284e.tar.gz
ttyrec-649450762eff2d71371e176534fbe64752a3284e.zip
metadata
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fdfef97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# ttyrec
+
+This crate contains helpers for reading and writing
+[ttyrec](https://en.wikipedia.org/wiki/Ttyrec) files.
+
+`Parser` and `Creator` can be used to read and write files manually, and
+`Reader` and `Writer` are helpers to provide a nicer API for asynchronous
+applications using `tokio`.