Fix typos

[rust-lightning] / src / lib.rs

diff --git a/src/lib.rs b/src/lib.rs
index 4a3ab27189da46f8ebac43eadbc8cf742ea082cf..52ec664023621954d162ba8f603a7cc4a21491cd 100644 (file)
--- 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 it's 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 bitcoin_hashes;
 extern crate rand;
-extern crate crypto;
-extern crate num; //TODO: Convince andrew to not rely on this for fucking casting...
+extern crate secp256k1;
+#[cfg(test)] extern crate hex;
 
+#[macro_use]
+pub mod util;
 pub mod chain;
 pub mod ln;
-pub mod util;