summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsharkdp <davidpeter@web.de>2021-01-10 21:18:50 +0100
committerDavid Peter <sharkdp@users.noreply.github.com>2021-01-10 22:24:32 +0100
commitb0e5828d3f6d9daa667055afd12801a182fe4a95 (patch)
tree08c5628e7dd2cb9df4b22eb25dd06ea413334014 /README.md
parentb7d499d1be0dfa2e18a409596a89c45fbb15c1dd (diff)
Add comment regarding use of bat as a library, closes #953
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
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.