mirror of
https://github.com/sharkdp/bat
synced 2024-11-04 18:00:24 +00:00
Update documentation
This commit is contained in:
parent
ec0ce05455
commit
eee35e54e9
@ -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;
|
||||
//!
|
||||
|
Loading…
Reference in New Issue
Block a user