From 17fc6b3eda370f99fee48420532ada8b497ecd8c Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sun, 27 Oct 2019 08:07:09 -0400 Subject: docs --- src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/lib.rs') diff --git a/src/lib.rs b/src/lib.rs index 7324edd..1de8daa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,9 @@ +//! 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`. mod creator; pub use creator::Creator; mod error; -- cgit v1.2.3-54-g00ecf