docs

1 files changed, 6 insertions, 0 deletions

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;