rm-lisa 0.5.1

A logging library for rem-verse, with support for inputs, tasks, and more.
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

# Lisa #

A CLI interface, and logging tool for Rem-Verse.

[![Crates.io](https://img.shields.io/crates/v/rm-lisa.svg)](https://crates.io/crates/rm-lisa)
[![Documentation](https://docs.rs/rm-lisa/badge.svg)][documentation]
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Crates.io downloads](https://img.shields.io/crates/d/rm-lisa)](https://crates.io/crates/rm-lisa)
![Maintenance](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)

## Key features ##

- Multiple Logging Formats, that are built for many individuals.
  - Colored for pretty ascii color & erasing interfaces.
  - Plaintext for a simple line based format ideal for braille displays, and
    local human log files.
  - JSON for structured logging, with quick parsing/slicing/dicing support.
- Task Status, and Logging.
  - Queue up many background tasks, and have log lines prefixed with task
    names, and status updates.
- T4T (terminal for terminal), have your own autocomplete-ing command inputs
	with full support for a wide variety of stty keybinds (that are re-bindable).
- Full customization at runtime of data to include by users.

## What is Lisa? ##

Lisa aims to be the de-factor logging library across all of Rem-Verse. It's
built for our needs first, and foremost. If you have a lot of similar opinions
to logging as us this will probably be a good fit.

If you have different opinions it may not be _yet_, but we'd be open to hearing
all feature requests! If there's something we can do to make lisa more useful,
we'd like to take that on!

## Installation ##

Install via Cargo by adding to your `Cargo.toml` file:

```toml
[dependencies]
rm-lisa = "^0.4.0"
```

You must also set `tracing-unstable`, and `tokio-unstable` enabled through
rustflags. The easiest way to do this is create a `.cargo/config.toml` file
in the root of your workspace:

```toml
[build]
rustflags = ["--cfg", "tokio_unstable", "--cfg", "tracing_unstable"]
```

This project's source code and documentation are licensed under the MIT license. See the [LICENSE](LICENSE) file for details.

[documentation]: https://docs.rs/rm-lisa