Add test_static_spendable_outputs_justice_tx_revoked_htlc*

[rust-lightning] / src / lib.rs

diff --git a/src/lib.rs b/src/lib.rs
index 1fa7b21e06aaefbdc8b94c7a24bbfe71c55c392e..bd71b15f35c302827607590199ec4029888f84fe 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,5 +1,16 @@
 #![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;