narlog 0.1.2

Colorful and minimal logger library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

![Narlog Version](https://img.shields.io/crates/v/narlog)
![Narlog Docs](https://img.shields.io/docsrs/narlog/latest)
![Narlog Downloads](https://img.shields.io/crates/d/narlog)
![Narlog GitHub Last Commit](https://img.shields.io/github/last-commit/mylu0x/narlog)
![Narlog GitHub Stars](https://img.shields.io/github/stars/mylu0x/narlog)
# Narlog
**Narlog** is a **colorful and minimal** logger library.
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Changelog](#changelog)

## Features
- **Lightweight**: Built with minimal dependencies
- **Colorful**: Colorful output with [owo-colors](https://crates.io/crates/owo-colors)

## Installation
Run **this command** on **your rust project root**:
```bash
cargo add narlog
```

## Usage
Using `Logger` struct ([examples/basic_logging.rs](./examples/basic_logging.rs)): 
```rust
use std::io;
use std::io::ErrorKind;
use narlog::Logger;

fn main() {
    let logger = Logger::new();
    let error = io::Error::new(ErrorKind::Other, "velit esse cillum dolore eu fugiat nulla pariatur");
    logger.trace("Lorem ipsum dolor sit amet");
    logger.info("consectetur adipiscing elit");
    logger.debug("sed do eiusmod tempor incididunt ut labore et dolore magna aliqua");
    logger.warn("Ut enim ad minim veniam");
    logger.error("quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat", Some(&error));
    logger.fatal("Duis aute irure dolor in reprehenderit in voluptate", Some(&error));
}
```
Using macros ([examples/macros.rs](./examples/macros.rs)):
```rust
use std::io;
use std::io::ErrorKind;
use narlog::{trace, debug, error, fatal, info, warn};

fn main() {
    let error = io::Error::new(ErrorKind::Other, "velit esse cillum dolore eu fugiat nulla pariatur");
    trace!("Lorem ipsum dolor sit amet");
    info!("consectetur adipiscing elit");
    debug!("sed do eiusmod tempor incididunt ut labore et dolore magna aliqua");
    warn!("Ut enim ad minim veniam");
    error!("quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat");
    error!("quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat", &error);
    fatal!("Duis aute irure dolor in reprehenderit in voluptate");
    fatal!("Duis aute irure dolor in reprehenderit in voluptate", &error);
}
```

## Changelog
### 0.1.2
- **Added** Badges to `README.md`
### 0.1.1
- **Added** Table of Contents to `README.md`
- **Added** Welcome message to `src/lib.rs`
### 0.1.0
- **Initial Version!**