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

fix: spiced up readme.md

Browse source
This commit is contained in:
ad4m 2022-07-18 16:36:10 +02:00 committed by GitHub
parent 13abe7f557
commit d4944682cb
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -11,7 +11,7 @@
<br> <br>
</p> </p>
## Usage ## ⚡ Usage
```rust ```rust
use spinoff::{Spinner, Spinners, Color}; 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. * 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: To run some of the included examples, use:
```bash ```bash
@ -54,10 +54,11 @@ cargo run --example all_spinners
cargo run --example simple 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). This crate is licensed under the [MIT license](LICENSE).