1
0
mirror of https://github.com/sharkdp/bat.git synced 2025-09-04 04:12:31 +01:00

Add comment regarding use of bat as a library, closes #953

This commit is contained in:
sharkdp
2021-01-10 21:18:50 +01:00
committed by David Peter
parent b7d499d1be
commit b0e5828d3f
2 changed files with 7 additions and 0 deletions

View File

@@ -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.