log4r/README.md

46 lines
1.1 KiB
Markdown

# log4r
A log4j-like logging framework for Rust.
## Overview
`log4r` is a simple, extensible logging framework inspired by log4j. It provides different log levels and an easy-to-use API for Rust applications.
## Features
- Multiple log levels (Trace, Debug, Info, Warn, Error)
- Simple API similar to log4j
- Thread-safe logging
- Timestamped log entries
- Configurable log levels
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
log4r = "0.1"
```
## Example
```rust
use log4r::{LogLevel, Logger};
fn main() {
// Initialize the logger with Debug level
Logger::init(LogLevel::Debug);
// Test all log levels
log4r::trace!("This is a trace message - won't be printed");
log4r::debug!("This is a debug message - will be printed");
log4r::info!("This is an info message - will be printed");
log4r::warn!("This is a warning message - will be printed");
log4r::error!("This is an error message - will be printed");
}
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.