Skip to content

Commit 581a800

Browse files
authored
Merge pull request #1248 from naveensrinivasan/naveen/feat/update-readme
Docs: Updated README to include crates information
2 parents e4387fa + f29e485 commit 581a800

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,24 @@ production-worthy implementation in 2021.
3333
Communications for Rust-Lightning and Lightning Development Kit happens through
3434
[LDK slack](http://lightningdevkit.org/).
3535

36+
Crates
37+
-----------
38+
1. [lightning](./lightning)
39+
The Core of the LDK library, implements the lightning protocol, channel state machine,
40+
and on-chain logic. Supports no-std and exposes on relatively low-level interfaces.
41+
2. [lightning-background-processor](./lightning-background-processor)
42+
Utilities to perform required background tasks for Rust Lightning.
43+
3. [lightning-block-sync](./lightning-block-sync)
44+
Utilities to fetch the chain data from a block source and feed them into Rust Lightning.
45+
4. [lightning-invoice](./lightning-invoice)
46+
Data structures to parse and serialize BOLT11 lightning invoices.
47+
5. [lightning-net-tokio](./lightning-net-tokio)
48+
Implementation of the rust-lightning network stack using Tokio.
49+
For Rust-Lightning clients which wish to make direct connections to Lightning P2P nodes,
50+
this is a simple alternative to implementing the required network stack, especially for those already using Tokio.
51+
6. [lightning-persister](./lightning-persister)
52+
Utilities to manage Rust-Lightning channel data persistence and retrieval.
53+
3654
About
3755
-----------
3856
LDK/Rust-Lightning is a generic library which allows you to build a lightning

0 commit comments

Comments
 (0)