Add tests for defaulting to creating tlv onions
[rust-lightning] / README.md
index bebbe68d6e735156eecce588c75dc5c70b43f798..dad0b39241576094ed5fe45d601d000bd0c3516d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,6 +33,24 @@ production-worthy implementation in 2021.
 Communications for Rust-Lightning and Lightning Development Kit happens through our LDK
 [slack](https://join.slack.com/t/lightningdevkit/shared_invite/zt-tte36cb7-r5f41MDn3ObFtDu~N9dCrQ) & [discord](https://discord.gg/5AcknnMfBw) channels.
 
+Crates
+-----------
+1. [lightning](./lightning)   
+  The Core of the LDK library, implements the lightning protocol, channel state machine, 
+  and on-chain logic. Supports no-std and exposes on relatively low-level interfaces.
+2. [lightning-background-processor](./lightning-background-processor)
+  Utilities to perform required background tasks for Rust Lightning.
+3. [lightning-block-sync](./lightning-block-sync)
+  Utilities to fetch the chain data from a block source and feed them into Rust Lightning.
+4. [lightning-invoice](./lightning-invoice)
+  Data structures to parse and serialize BOLT11 lightning invoices.
+5. [lightning-net-tokio](./lightning-net-tokio)
+  Implementation of the rust-lightning network stack using Tokio.
+  For Rust-Lightning clients which wish to make direct connections to Lightning P2P nodes,
+  this is a simple alternative to implementing the required network stack, especially for those already using Tokio.
+6. [lightning-persister](./lightning-persister)
+  Utilities to manage Rust-Lightning channel data persistence and retrieval.
+
 About
 -----------
 LDK/Rust-Lightning is a generic library which allows you to build a lightning