Mirrors/bat
2
0
Fork 0
mirror of https://github.com/sharkdp/bat synced 2024-11-27 22:30:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
sharkdp 2020-04-22 19:23:45 +02:00 committed by David Peter
parent ec0ce05455
commit eee35e54e9
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/lib.rs
View file

@ -1,5 +1,12 @@
//! `bat` is a library to print syntax highlighted content.
//!
//! The main struct is `PrettyPrinter` which can be used to configure and
//! run the syntax highlighting.
//! If you need more control, you can also use the structs in the submodules
//! (start with `controller::Controller`), but note that the API of these
//! internal modules much more likely to change.
//!
//! "Hello world" example:
//! ```
//! use bat::PrettyPrinter;
//!