summaryrefslogtreecommitdiffstats
path: root/vendor/indicatif/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/indicatif/README.md')
-rw-r--r--vendor/indicatif/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/indicatif/README.md b/vendor/indicatif/README.md
new file mode 100644
index 000000000..3fde30bdc
--- /dev/null
+++ b/vendor/indicatif/README.md
@@ -0,0 +1,30 @@
+# indicatif
+
+[![Documentation](https://docs.rs/indicatif/badge.svg)](https://docs.rs/indicatif/)
+[![Crates.io](https://img.shields.io/crates/v/indicatif.svg)](https://crates.io/crates/indicatif)
+[![Build status](https://github.com/console-rs/indicatif/workflows/CI/badge.svg)](https://github.com/console-rs/indicatif/actions/workflows/rust.yml)
+[![Chat](https://img.shields.io/discord/976380008299917365?logo=discord)](https://discord.gg/YHmNA3De4W)
+
+A Rust library for indicating progress in command line applications to users.
+
+This currently primarily provides progress bars and spinners as well as basic
+color support, but there are bigger plans for the future of this!
+
+## Examples
+
+[examples/yarnish.rs](examples/yarnish.rs)
+<img src="https://github.com/console-rs/indicatif/blob/main/screenshots/yarn.gif?raw=true">
+
+[examples/download.rs](examples/download.rs)
+<img src="https://github.com/console-rs/indicatif/blob/main/screenshots/download.gif?raw=true">
+
+[examples/multi.rs](examples/multi.rs)
+<img src="https://github.com/console-rs/indicatif/blob/main/screenshots/multi-progress.gif?raw=true">
+
+[examples/single.rs](examples/single.rs)
+<img src="https://github.com/console-rs/indicatif/blob/main/screenshots/single.gif?raw=true">
+
+## Integrations
+
+You can use [indicatif-log-bridge](https://crates.io/crates/indicatif-log-bridge) to integrate with the
+[log crate](https://crates.io/crates/log) and avoid having both fight for your terminal.