Skip to content

Latest commit

 

History

History
172 lines (113 loc) · 4.46 KB

README.md

File metadata and controls

172 lines (113 loc) · 4.46 KB
Raw

Issues MIT License


cat-loggr-rs

A simple, lightweight utility for making beautiful logs, based on cat-loggr
Explore the docs »

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Usage
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

cat-loggr-rs Screen Shot

A simple, lightweight utility for making beautiful logs, based on cat-loggr

(back to top)

Usage

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

(back to top)

Default Log Levels

  • fatal
  • error
  • warn
  • trace
  • init
  • info
  • verbose
  • debug

Roadmap

  • Feature parity
    • Custom log levels
    • After hooks
    • Level threshold
    • Pre-hook
    • Argument hooks
    • Meta
      • Color option
  • Macro for panics
  • Tests

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/Sven65/cat-loggr-rs

(back to top)

Acknowledgments

(back to top)