Skip to content

Commit cdab359

Browse files
committed
Update documentation and bump version
1 parent cc011a8 commit cdab359

2 files changed

Lines changed: 16 additions & 4 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "simple_logger"
3-
version = "4.0.0"
3+
version = "4.1.0"
44
license = "MIT"
55
authors = ["Sam Clements <sam@borntyping.co.uk>"]
66
description = "A logger that prints all messages with a readable output format"

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A logger that prints all messages with a readable output format.
44

5-
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.
5+
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.
66

77
* [Source on GitHub](https://github.com/borntyping/rust-simple_logger)
88
* [Packages on Crates.io](https://crates.io/crates/simple_logger)
@@ -38,7 +38,7 @@ You can run the above example with:
3838
cargo run --example init
3939
```
4040

41-
Coloured output and timestamps will be enabled by default. You can remove these
41+
The `colors` and `timestamps` features are enabled by default. You can remove these
4242
features and their respective dependencies by disabling all features in your
4343
`Cargo.toml`.
4444

@@ -63,14 +63,26 @@ default-features = false
6363
features = ["colors"]
6464
```
6565

66+
To include thread metadata use the `threads` and `nightly` features:
67+
68+
```toml
69+
[dependencies.simple_logger]
70+
features = ["threads", "nightly"]
71+
```
72+
6673
To direct logging output to `stderr` use the `stderr` feature:
6774

6875
```toml
6976
[dependencies.simple_logger]
7077
features = ["stderr"]
7178
```
7279

73-
This can be combined with any other feature.
80+
Multiple features can be combined.
81+
82+
```toml
83+
[dependencies.simple_logger]
84+
features = ["colors", "threads", "timestamps", "nightly", "stderr"]
85+
```
7486

7587
Licence
7688
-------

0 commit comments

Comments
 (0)