Improve routing-related documentation
[rust-lightning] / lightning / src / ln / mod.rs
index 33f1c5bc1cfb019eb9937b12b5b22502f7dee56a..163799b0031d4a509e7865f3e39253329bd2c141 100644 (file)
@@ -1,13 +1,13 @@
 //! High level lightning structs and impls live here.
 //!
-//! You probably want to create a channelmanager::ChannelManager, and a router::Router first.
+//! You probably want to create a channelmanager::ChannelManager, and a routing::NetGraphMsgHandler 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.
+//! call into your NetGraphMsgHandler.
 
 pub mod channelmanager;
 pub mod channelmonitor;