Skip to content

Commit c028239

Browse files
committed
Describe third-party service crates in README and documentation
1 parent 338a88f commit c028239

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ Fast, highly configurable Rust logging crate, inspired by the C++ logging librar
1919
- standard streams with optional color support;
2020
- files (single file, rotating hourly, daily, periodically or by file size);
2121
- platform-specific (e.g. `journald` for Linux and `OutputDebugStringW` for Windows);
22-
- ... and able to implement one yourself.
22+
- third-party services (maintained in separate repositories):
23+
- [spdlog-telegram](https://crates.io/crates/spdlog-telegram)
24+
- ... more ideas? see [#103].
25+
- and able to implement one yourself.
2326
- Structured logging.
2427
- Configuring via environment variables.
2528
- Readable level filters.
@@ -72,7 +75,7 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
7275

7376
[spdlog]: https://github.com/gabime/spdlog
7477
[Benchmarks]: https://github.com/SpriteOvO/spdlog-rs/blob/main/spdlog/benches/README.md
75-
[#25]: https://github.com/SpriteOvO/spdlog-rs/issues/25
78+
[#103]: https://github.com/SpriteOvO/spdlog-rs/issues/103
7679
[./examples]: https://github.com/SpriteOvO/spdlog-rs/tree/main/spdlog/examples
7780
[docs.rs]: https://docs.rs/spdlog-rs/
7881
[open a discussion]: https://github.com/SpriteOvO/spdlog-rs/discussions/new

spdlog/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,12 @@
9393
//! [`RotatingFileSink`] that automatically rotates files by time point or file
9494
//! size, and [`AsyncPoolSink`] that outputs logs asynchronously.
9595
//!
96+
//! Sinks for third-party services are maintained in separate repositories.
97+
//! Known crates are:
98+
//!
99+
//! - [spdlog-telegram](https://crates.io/crates/spdlog-telegram)
100+
//! - ... More ideas? See [#103].
101+
//!
96102
//! ## Logger
97103
//!
98104
//! A complex program may consist of many separated components.
@@ -266,6 +272,7 @@
266272
//! [`FileSink`]: crate::sink::FileSink
267273
//! [`RotatingFileSink`]: crate::sink::RotatingFileSink
268274
//! [`AsyncPoolSink`]: crate::sink::AsyncPoolSink
275+
//! [#103]: https://github.com/SpriteOvO/spdlog-rs/issues/103
269276
//! [./examples]: https://github.com/SpriteOvO/spdlog-rs/tree/main/spdlog/examples
270277
//! [open a discussion]: https://github.com/SpriteOvO/spdlog-rs/discussions/new
271278
//! [open an issue]: https://github.com/SpriteOvO/spdlog-rs/issues/new/choose

0 commit comments

Comments
 (0)