spinoff/README.md

55 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2022-07-15 12:59:22 -05:00
# spinoff
`spinoff` is a simple to use library for displaying spinners in the terminal, with plenty of features and options.
2022-07-15 14:34:36 -05:00
[![Version](https://img.shields.io/crates/v/spinoff.svg)](https://crates.io/crates/spinoff) [![Downloads](https://img.shields.io/crates/d/spinoff)](https://crates.io/crates/spinoff) [![Docs](https://img.shields.io/docsrs/spinoff)](https://docs.rs/spinoff/latest/spinoff/)
2022-07-15 12:59:22 -05:00
## Usage
```rust
use spinoff::Spinners;
use std::thread::sleep;
use std::time::Duration;
2022-07-16 05:38:43 -05:00
let spinner = spinoff::new(Spinners::Dots, "Loading...", "blue".into()); // Can also be Some("blue") or None
2022-07-15 12:59:22 -05:00
sleep(Duration::from_secs(3));
spinner.success("Done!");
```
2022-07-16 05:38:43 -05:00
### Update a spinner
```rust
use spinoff::Spinners;
use std::thread::sleep;
use std::time::Duration;
let mut spinner = spinoff::new(Spinners::Dots, "Loading...", "blue".into());
sleep(Duration::from_secs(3));
spinner = spinner.update(Spinners::Dots2, "Loading...", None);
sleep(Duration::from_secs(3));
spinner.stop_and_persist("👨‍💻", "Done!");
2022-07-16 05:38:43 -05:00
```
2022-07-15 12:59:22 -05:00
## Documentation
* All documentation can be found on the [Docs.rs page](https://docs.rs/spinoff/latest/spinoff/).
* If you want to see all the available `Spinner` options, check the [`Spinners`](src/utils/spinner_enum.rs) enum.
## Examples
To run some of the included examples, use:
```bash
cargo run --example all_spinners
```
```bash
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](LICENSE).