README.md

logly.rs

Logly is a simple logging utility for rust that provides an easy way to log messages with different levels, colors, and options. It is designed to be flexible, allowing you to customize the log messages based on your application's needs. Logly supports logging to both the console and a file, and it comes with built-in color-coded log levels for better visibility.

if you like this project make sure to star 🌟 it in the repository and if you want to contribute make sure to fork this repository❤✨.

Installation

cargo add logly

Usage

use logly::logly::*;

let logly = logly::new(); //intialize the logly

logly.start_logging("test_log.txt"); //start storing the log messages in txt, make sure to pass to create the log file

logly.info("Key1", "Value1", LogColor::Cyan); // message with custom color if you don't want just set it None
logly.warn("Key2", "Value2", LogColor::Yellow);

logly.stop_logging(); //this will stop storing the message from here but it will display
logly.warn("Key3", "Value3", LogColor::Yellow);

Color Options:

Default Color Options:

Level	Color Code
INFO	CYAN
WARNING	YELLOW
ERROR	RED
DEBUG	BLUE
CRITICAL	BRIGHT RED
TRACE	BLUE
DEFAULT	WHITE

Custom Color Options:

You can use any of the following color codes for custom coloring:

NAME	Color Code
CYAN	CYAN
YELLOW	YELLOW
RED	RED
BLUE	BLUE
BRIGHT RED	CRITICAL
WHITE	WHITE

Contributing

Contributions are welcome! Before contributing, please read our Contributing Guidelines to ensure a smooth and collaborative development process.

Issues

If you encounter any issues or have suggestions, feel free to open an issue on GitHub!

Code of Conduct

Please review our Code of Conduct to understand the standards of behavior we expect from contributors and users of this project.

License

This project is licensed under the MIT License. See LICENSE for more details.

Support the Project

💰 You can help this improve more by offering a little support! ❤️

Happy Coding ❤️