<a name="readme-top"></a>
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
<br />
<div align="center">
<h3 align="center">cat-loggr-rs</h3>
<p align="center">
A simple, lightweight utility for making beautiful logs, based on <a href="https://github.com/Ratismal/cat-loggr">cat-loggr</a>
<br />
<a href="https://docs.rs/cat-loggr"><strong>Explore the docs »</strong></a>
<br />
<br />
·
<a href="https://github.com/Sven65/cat-loggr-rs/issues">Report Bug</a>
·
<a href="https://github.com/Sven65/cat-loggr-rs/issues">Request Feature</a>
</p>
</div>
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
## About The Project
[![cat-loggr-rs Screen Shot][product-screenshot]](#)
A simple, lightweight utility for making beautiful logs, based on [cat-loggr](https://github.com/Ratismal/cat-loggr)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Usage
```rust
use cat_loggr::CatLoggr;
fn main() {
let logger = CatLoggr::new(None);
logger.log("This is a log", "info");
}
```
_For more examples, please refer to the [Documentation](https://docs.rs/cat-loggr/)_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Default Log Levels
- fatal
- error
- warn
- trace
- init
- info
- verbose
- debug
## Roadmap
- [ ] Feature parity
- [x] Custom log levels
- [x] After hooks
- [x] Level threshold
- [ ] Pre-hook
- [ ] Argument hooks
- [ ] Meta
- [ ] Color option
- [ ] Macro for panics
- [x] Tests
See the [open issues](https://github.com/Sven65/cat-loggr-rs/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## License
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Contact
Project Link: [https://github.com/Sven65/cat-loggr-rs](https://github.com/Sven65/cat-loggr-rs)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
## Acknowledgments
* [Best readme template](https://github.com/othneildrew/Best-README-Template)
* [cat-loggr](https://github.com/Ratismal/cat-loggr)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
[issues-shield]: https://img.shields.io/github/issues/Sven65/cat-loggr-rs.svg?style=for-the-badge
[issues-url]: https://github.com/Sven65/cat-loggr-rs/issues
[license-shield]: https://img.shields.io/github/license/Sven65/cat-loggr-rs.svg?style=for-the-badge
[license-url]: https://github.com/Sven65/cat-loggr-rs/blob/master/LICENSE.txt
[product-screenshot]: https://raw.githubusercontent.com/Sven65/cat-loggr-rs/master/images/demo.png