From cdab359515dd6069f0d8eff806bb24d0ec89a960 Mon Sep 17 00:00:00 2001 From: Sam Clements Date: Sat, 18 Mar 2023 20:06:01 +0000 Subject: [PATCH] Update documentation and bump version --- Cargo.toml | 2 +- README.md | 18 +++++++++++++++--- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index ac1f99b..0e00937 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "simple_logger" -version = "4.0.0" +version = "4.1.0" license = "MIT" authors = ["Sam Clements "] description = "A logger that prints all messages with a readable output format" diff --git a/README.md b/README.md index a4974e3..2cfa241 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ A logger that prints all messages with a readable output format. -The output format is based on the format used by [Supervisord](https://github.com/Supervisor/supervisor), with timestamps in default [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format and custom format. +The output format is based on the format used by [Supervisord](https://github.com/Supervisor/supervisor), with timestamps default [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) format. The format used for timestamps can be customised. * [Source on GitHub](https://github.com/borntyping/rust-simple_logger) * [Packages on Crates.io](https://crates.io/crates/simple_logger) @@ -38,7 +38,7 @@ You can run the above example with: cargo run --example init ``` -Coloured output and timestamps will be enabled by default. You can remove these +The `colors` and `timestamps` features are enabled by default. You can remove these features and their respective dependencies by disabling all features in your `Cargo.toml`. @@ -63,6 +63,13 @@ default-features = false features = ["colors"] ``` +To include thread metadata use the `threads` and `nightly` features: + +```toml +[dependencies.simple_logger] +features = ["threads", "nightly"] +``` + To direct logging output to `stderr` use the `stderr` feature: ```toml @@ -70,7 +77,12 @@ To direct logging output to `stderr` use the `stderr` feature: features = ["stderr"] ``` -This can be combined with any other feature. +Multiple features can be combined. + +```toml +[dependencies.simple_logger] +features = ["colors", "threads", "timestamps", "nightly", "stderr"] +``` Licence -------