summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJokler <jokler.contact@gmail.com>2017-10-28 23:10:06 +0200
committerJokler <jokler.contact@gmail.com>2017-10-28 23:10:06 +0200
commitfeafddfde3a42725db8f4d68eb6c6a8e5058ed87 (patch)
treeeea529eb103bfddb2ea0284c484c2cdf9ea11b07
parent9d77de5e5d133b990983040b01cc0cb22b2f526b (diff)
downloadfrippy-feafddfde3a42725db8f4d68eb6c6a8e5058ed87.tar.gz
frippy-feafddfde3a42725db8f4d68eb6c6a8e5058ed87.zip
Document the usage of the log crate
-rw-r--r--src/lib.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 5b8d479..d912973 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -4,12 +4,16 @@
//! Frippy is an IRC bot that runs plugins on each message
//! received.
//!
-//! # Example
+//! ## Example
//! ```no_run
//! extern crate frippy;
//!
//! frippy::run();
//! ```
+//!
+//! # Logging
+//! Frippy uses the [log](https://docs.rs/log) crate so you can log events
+//! which might be of interest.
#[macro_use]
extern crate log;