X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fln%2Fmod.rs;h=ca8acd50dde7a865c19686fb4e7f8d89d7b8031a;hb=ed30a199e35070c85fdf8199ec4ea65bcbec9a47;hp=fe4eeed8e7d49d8e4742b7a03d1bc4e4021cf906;hpb=da6171d50d36403af2c1f09c33b6a105884b4b9c;p=rust-lightning

diff --git a/src/ln/mod.rs b/src/ln/mod.rs
index fe4eeed8..ca8acd50 100644
--- a/src/ln/mod.rs
+++ b/src/ln/mod.rs
@@ -1,3 +1,14 @@
+//! High level lightning structs and impls live here.
+//!
+//! You probably want to create a channelmanager::ChannelManager, and a router::Router first.
+//! Then, you probably want to pass them both on to a peer_handler::PeerManager and use that to
+//! create/manage connections and call get_and_clear_pending_events after each action, handling
+//! them appropriately.
+//!
+//! When you want to open/close a channel or send a payment, call into your ChannelManager and when
+//! you want to learn things about the network topology (eg get a route for sending a payment),
+//! call into your Router.
+
 pub mod channelmanager;
 pub mod channelmonitor;
 pub mod msgs;