diff options
author | sharkdp <davidpeter@web.de> | 2020-04-22 19:23:45 +0200 |
---|---|---|
committer | David Peter <sharkdp@users.noreply.github.com> | 2020-04-22 23:55:28 +0200 |
commit | eee35e54e962898dfd8be1b6b0d48d885a4f0319 (patch) | |
tree | 40bc52a193fded026812c2cd8a5b5ffa90a4e6a7 | |
parent | ec0ce054559e3821ddfcbbd0fa60b0b30117b6fa (diff) |
Update documentation
-rw-r--r-- | src/lib.rs | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -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; //! |