]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Docs: Updated README to include crates information
authornaveen <172697+naveensrinivasan@users.noreply.github.com>
Tue, 18 Jan 2022 02:43:45 +0000 (02:43 +0000)
committernaveen <172697+naveensrinivasan@users.noreply.github.com>
Wed, 19 Jan 2022 19:27:11 +0000 (19:27 +0000)
Included crates information into README.

README.md

index f44f59a3fb4850dbf8dfc21fed90bc2816b85479..ea1f08ae165e0ecbb3b1a49c15ab209bf43ab7e9 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
 [LDK slack](http://lightningdevkit.org/).
 
+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