diff --git a/Cargo.toml b/Cargo.toml index 865d1f85..66a11adf 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -30,6 +30,8 @@ application = [ ] git = ["git2"] # Support indicating git modifications paging = ["shell-words"] # Support applying a pager on the output + +# You need to use one of these if you depend on bat as a library: regex-onig = ["syntect/regex-onig"] # Use the "oniguruma" regex engine regex-fancy = ["syntect/regex-fancy"] # Use the rust-only "fancy-regex" engine diff --git a/README.md b/README.md index c2c884d5..8c89b7c0 100644 --- a/README.md +++ b/README.md @@ -692,6 +692,11 @@ bash assets/create.sh cargo install --path . --locked --force ``` +If you want to build an application that uses `bat`s pretty-printing +features as a library, check out the [the API documentation](https://docs.rs/bat/). +Note that you have to use either `regex-onig` or `regex-fancy` as a feature +when you depend on `bat` as a library. + ## Contributing Take a look at the [`CONTRIBUTING.md`](CONTRIBUTING.md) guide.