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

diff --git a/src/lib.rs b/src/lib.rs
index 4a3ab271..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 secp256k1;
-extern crate rand;
 extern crate crypto;
-extern crate num; //TODO: Convince andrew to not rely on this for fucking casting...
+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;