X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=inline;f=src%2Flib.rs;h=52ec664023621954d162ba8f603a7cc4a21491cd;hb=c50aa05231cc5b2708e1d6e7913457999d8f1ed8;hp=1fa7b21e06aaefbdc8b94c7a24bbfe71c55c392e;hpb=1a9ef40203da58e03defd13379983e6474c20d1b;p=rust-lightning diff --git a/src/lib.rs b/src/lib.rs index 1fa7b21e..52ec6640 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,7 +1,18 @@ #![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 crypto; +extern crate bitcoin_hashes; extern crate rand; extern crate secp256k1; #[cfg(test)] extern crate hex;