spinoff/README.md
2022-07-15 21:34:36 +02:00

1.2 KiB

spinoff

spinoff is a simple to use library for displaying spinners in the terminal, with plenty of features and options.

Version Downloads Docs

Usage

use spinoff::Spinners;
use std::thread::sleep;
use std::time::Duration;

let spinner = spinoff::new(Spinners::Dots, "Loading...", "Blue".into()); // Can also be Some("blue") or None
sleep(Duration::from_secs(3));
spinner.success("Done!");

Documentation

  • All documentation can be found on the Docs.rs page.
  • If you want to see all the available Spinner options, check the Spinners enum.

Examples

To run some of the included examples, use:

cargo run --example all_spinners
cargo run --example simple

Contributing

Any contributions to this crate are highly appreciated. If you have any ideas/suggestions/bug fixes, please open an issue or pull request.

License

This crate is licensed under the MIT license.