X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Flib.rs;h=bd71b15f35c302827607590199ec4029888f84fe;hb=b6b5decfa9169f634b18a77b10f7ae6a20a6f240;hp=a5e291d3075e491a4595f2778b4df8b696d261d5;hpb=fe9bb1d97028d1c0c98972809d12e7129d18356d;p=rust-lightning

diff --git a/src/lib.rs b/src/lib.rs
index a5e291d3..bd71b15f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,11 +1,23 @@
 #![crate_name = "lightning"]
 
+//! Rust-Lightning, not Rusty's Lightning!
+//!
+//! A full-featured but also flexible lightning implementation, in library form. This allows the
+//! user (you) to decide how they wish to use it instead of being a fully self-contained daemon.
+//! This means there is no built-in threading/execution environment and its up to the user to
+//! figure out how best to make networking happen/timers fire/things get written to disk/keys get
+//! generated/etc. This makes it a good candidate for tight integration into an existing wallet
+//! instead of having a rather-separate lightning appendage to a wallet.
+
+#![cfg_attr(not(feature = "fuzztarget"), deny(missing_docs))]
+
 extern crate bitcoin;
 extern crate crypto;
 extern crate rand;
 extern crate secp256k1;
 #[cfg(test)] extern crate hex;
 
+#[macro_use]
+pub mod util;
 pub mod chain;
 pub mod ln;
-pub mod util;