on master help sign in
Update documentation
commiteee35e54e962898dfd8be1b6b0d48d885a4f0319 authorsharkdp <davidpeter@web.de> dateWed 22 Apr 2020, 19:23 (7 years ago) parentec0ce05
1 file changed+7
src/lib.rs+7
src/lib.rs+7
@@ -1,5 +1,12 @@
11//! `bat` is a library to print syntax highlighted content.
22//!
3+//! The main struct is `PrettyPrinter` which can be used to configure and
4+//! run the syntax highlighting.
5+//! If you need more control, you can also use the structs in the submodules
6+//! (start with `controller::Controller`), but note that the API of these
7+//! internal modules much more likely to change.
8+//!
9+//! "Hello world" example:
310//! ```
411//! use bat::PrettyPrinter;
512//!