From d4944682cb2f4d64117421581ec5a5f66d0c4499 Mon Sep 17 00:00:00 2001 From: ad4m <94195860+ad4mx@users.noreply.github.com> Date: Mon, 18 Jul 2022 16:36:10 +0200 Subject: [PATCH] fix: spiced up readme.md --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 49280b1..b550c1f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@

-## Usage +## ⚡ Usage ```rust use spinoff::{Spinner, Spinners, Color}; @@ -38,12 +38,12 @@ spinner.stop_and_persist("👨‍💻", "Done!"); ``` -## Documentation +## 📖 Documentation -* All documentation can be found on the [Docs.rs page](https://docs.rs/spinoff/latest/spinoff/). +* All relevant 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 +## 🔨 Examples To run some of the included examples, use: ```bash @@ -54,10 +54,11 @@ cargo run --example all_spinners cargo run --example simple ``` -## Contributing +## 🚧 Contributing -Any contributions to this crate are highly appreciated. If you have any ideas/suggestions/bug fixes, please open an issue or pull request. +Any contributions to this crate are highly appreciated. If you have any ideas/suggestions/bug fixes, please open an issue or a pull request. +If you like the project, [star this project on GitHub.](https://github.com/ad4mx/spinoff) -## License +## 📑 License -This crate is licensed under the [MIT license](LICENSE). \ No newline at end of file +This crate is licensed under the [MIT license](LICENSE).