From 021537f768e5f12e377765ebb4ef332793553cbe Mon Sep 17 00:00:00 2001
From: Trevor Gross <tmgross@umich.edu>
Date: Tue, 31 Jan 2023 17:18:49 -0500
Subject: [PATCH] Added example to lib.rs

---
 src/lib.rs | 33 ++++++++++++++++++++++++++-------
 1 file changed, 26 insertions(+), 7 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 6cd19f9..868720e 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,29 @@
+//! A logger implementation to use RTT with the Rust `log` crate.
+//!
+//! ```
+//! use log::{info, LevelFilter};
+//! use rtt_logger::RTTLogger;
+//! use rtt_target::rtt_init_print;
+//!
+//! // logger configuration
+//! const LOG_LEVEL: LevelFilter = LevelFilter::Info;
+//! static LOGGER: RTTLogger = RTTLogger::new(LOG_LEVEL);
+//!
+//! fn main() {
+//!     // logger setup
+//!     rtt_init_print!();
+//!     log::set_logger(&LOGGER)
+//!         .map(|()| log::set_max_level(LOG_LEVEL))
+//!         .unwrap();
+//!
+//!     // logger usage in main binary or in any library
+//!     info!("Hello World!");
+//! }
+//! ```
+
 #![no_std]
 
-use log::{Metadata, Record, LevelFilter};
+use log::{LevelFilter, Metadata, Record};
 
 use rtt_target::*;
 
@@ -14,9 +37,7 @@ impl RTTLogger {
     ///
     /// * `level_filter`: The default level to enable.
     pub const fn new(level_filter: LevelFilter) -> RTTLogger {
-        RTTLogger {
-            level_filter
-        }
+        RTTLogger { level_filter }
     }
 }
 
@@ -31,7 +52,5 @@ impl log::Log for RTTLogger {
         }
     }
 
-    fn flush(&self) {
-    }
+    fn flush(&self) {}
 }
-