Update docs

ecliptical · Nov 14, 2021 · 088fa05 · 088fa05
1 parent 9c2fb1f
commit 088fa05
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,3 +2,7 @@
 
 Adapters for connecting structured log records from the [`slog`](https://github.com/slog-rs/slog) crate
 into the [`tracing`](https://github.com/tokio-rs/tracing) ecosystem.
+
+Use when a library uses `slog` but your application uses `tracing`.
+
+Heavily inspired by [tracing-log](https://github.com/tokio-rs/tracing/tree/5fdbcbf61da27ec3e600678121d8c00d2b9b5cb1/tracing-log).
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,8 @@
-//! Adapters for connecting structured log records from the `slog` crate into the `tracing` ecosystem.
+//! Adapters for connecting structured log records from the [slog] crate into the [tracing](https://github.com/tokio-rs/tracing) ecosystem.
+//!
+//! Use when a library uses `slog` but your application uses `tracing`.
+//!
+//! Heavily inspired by [tracing-log](https://github.com/tokio-rs/tracing/tree/5fdbcbf61da27ec3e600678121d8c00d2b9b5cb1/tracing-log).
 
 use lazy_static::lazy_static;