diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 8 |
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`. |