forestry 0.1.0

A simple cross-platform CLI logging library for Rust
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

# Forestry

A CLI logging library.

## Table of Contents

* [Installation](#installation)
* [Dependencies](#dependencies)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)

## Installation

To install forestry, simply add it to your Rust project via Cargo:

```bash
cargo add forestry
```

## Dependencies

Forestry depends on the `colored` crate for colorized output.

## Usage

Forestry is a simple logging library that allows you to log messages to the console with different levels of severity. Here's an example of how to use it:

```rust
use forestry::prelude::*;

let l = Logger::new();
l.i("This is an info message.");
l.w("This is a warning message.");
l.e("This is an error message.");
l.s("This is a success message.");
```

This will output the following to the console:

```
[*] This is an info message.
[~] This is a warning message.
[!] This is an error message.
[✔] This is a success message.
```

It will also be coloured in most terminals.

## Contributing

If you would like to contribute to forestry, please open an issue or submit a pull request.

## License

This code is dual-licensed under either the MIT or Apache 2.0 license, at your option. Please see the `LICENSE` file for more information.