able/spinoff
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix: added another example to readme

Browse source
This commit is contained in:
ad4mx 2022-07-18 19:46:59 +02:00
parent 227a093404
commit 700eb9a91d
1 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -4,12 +4,7 @@
[![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) [![License](https://img.shields.io/crates/l/spinoff)](https://crates.io/crates/spinoff) ![Actions](https://img.shields.io/github/workflow/status/ad4mx/spinoff/Rust) [![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) [![License](https://img.shields.io/crates/l/spinoff)](https://crates.io/crates/spinoff) ![Actions](https://img.shields.io/github/workflow/status/ad4mx/spinoff/Rust)
<p> ![til](assets/index.gif)
<br>
<img width="800" src="assets/index.gif">
<br>
<br>
</p>
## ⚡ Usage ## ⚡ Usage
@ -30,13 +25,27 @@ use spinoff::{Spinner, Spinners, Color};
use std::thread::sleep; use std::thread::sleep;
use std::time::Duration; use std::time::Duration;
let mut spinner = Spinner::new(Spinners::Dots, "Loading...", Some(Color::Blue)); let mut spinner = Spinner::new(Spinners::Dots, "Loading...", Some(Color::Red));
sleep(Duration::from_secs(3)); sleep(Duration::from_secs(3));
spinner.update(Spinners::Dots2, "Loading...", None); spinner.update(Spinners::Dots2, "Loading...", None);
sleep(Duration::from_secs(3)); sleep(Duration::from_secs(3));
spinner.stop_and_persist("👨‍💻", "Done!"); spinner.stop_and_persist("👨‍💻", "Done!");
``` ```
### Stop a spinner and persist a symbol and message
```rust
use spinoff::{Spinner, Spinners, Color};
use std::thread::sleep;
use std::time::Duration;
let mut spinner = Spinner::new(Spinners::Dots, "Loading...", Some(Color::Green));
sleep(Duration::from_secs(3));
spinner.stop_and_persist("📜", "Task done.");
```
Other examples can be found in the [documentation](https://docs.rs/spinoff/latest/spinoff/).
## 📖 Documentation ## 📖 Documentation