diff --git a/README.md b/README.md index a9c016a..1c61c1a 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,13 @@ vte Parser for implementing virtual terminal emulators in Rust. The parser is implemented according to [Paul Williams' ANSI parser state -machine]. The state machine doesn't assign meaning to the parsed data and is -thus not itself sufficient for writing a terminal emulator. Instead, it is -expected that an implementation of the `Perform` trait which does something -useful with the parsed data. The `Parser` handles the book keeping, and the -`Perform` gets to simply handle actions. +machine], modified to work in terms of UTF-8 encodings. + +The state machine doesn't assign meaning to the parsed data and is thus not +itself sufficient for writing a terminal emulator. Instead, it is expected that +an implementation of the `Perform` trait which does something useful with the +parsed data. The `Parser` handles the book keeping, and the `Perform` gets to +simply handle actions. See the [docs] for more info. diff --git a/src/lib.rs b/src/lib.rs index a7b92f2..ac546fa 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,11 +1,13 @@ //! Parser for implementing virtual terminal emulators //! //! [`Parser`] is implemented according to [Paul Williams' ANSI parser -//! state machine]. The state machine doesn't assign meaning to the parsed data -//! and is thus not itself sufficient for writing a terminal emulator. Instead, -//! it is expected that an implementation of [`Perform`] is provided which does -//! something useful with the parsed data. The [`Parser`] handles the book -//! keeping, and the [`Perform`] gets to simply handle actions. +//! state machine], modified to work in terms of UTF-8 encodings. +//! +//! The state machine doesn't assign meaning to the parsed data and is thus not +//! itself sufficient for writing a terminal emulator. Instead, it is expected that +//! an implementation of [`Perform`] is provided which does something useful with the +//! parsed data. The [`Parser`] handles the book keeping, and the [`Perform`] gets to +//! simply handle actions. //! //! # Examples //!