docs

1 files changed, 19 insertions, 2 deletions

diff --git a/README.md b/README.md
index f038a33..29c25d5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
-This crate parses terminal data into an in-memory representation of the
-screen. Building requires glib-2.0, gcc, and flex.
+# vt100
+
+This crate parses a terminal byte stream and provides an in-memory
+representation of the rendered contents.
+
+## Overview
+
+This is essentially the terminal parser component of a graphical terminal
+emulator pulled out into a separate crate. This can be used to not only
+build graphical terminal emulators, but also many other types of
+applications that need to interact with a terminal data stream directly,
+such as terminal multiplexers or terminal recording applications.
+
+## Synopsis
+
+```rust
+let mut screen = vt100::Screen::new(24, 80);
+screen.process(b"this text is \x1b[31mRED\x1b[m");
+```