Skip to content

Commit 4d0bc19

Browse files
--wip-- [skip ci]
Signed-off-by: naveen <[email protected]>
1 parent 25fd84d commit 4d0bc19

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,22 @@ Communications for Rust-Lightning and Lightning Development Kit happens through
3535

3636
Crates
3737
-----------
38-
1. [lightning](./lightning)
39-
1. [lightning-background-processor](./lightning-background-processor)
40-
1. [lightning-block-sync](./lightning-block-sync)
41-
1. [lightning-invoice](./lightning-invoice)
42-
1. [lightning-net-tokio](./lightning-net-tokio)
43-
1. [lightning-persister](./lightning-persister)
38+
1. [lightning](./lightning)
39+
A Bitcoin Lightning library in Rust.
40+
Does most of the hard work, without implying a specific runtime, requiring clients implement basic
41+
network logic, chain interactions and disk storage.
42+
2. [lightning-background-processor](./lightning-background-processor)
43+
Utilities to perform required background tasks for Rust Lightning.
44+
3. [lightning-block-sync](./lightning-block-sync)
45+
Utilities to fetch the chain data from a block source and feed them into Rust Lightning.
46+
4. [lightning-invoice](./lightning-invoice)
47+
Data structures to parse and serialize BOLT11 lightning invoices.
48+
5. [lightning-net-tokio](./lightning-net-tokio)
49+
Implementation of the rust-lightning network stack using Tokio.
50+
For Rust-Lightning clients which wish to make direct connections to Lightning P2P nodes,
51+
this is a simple alternative to implementing the required network stack, especially for those already using Tokio.
52+
6. [lightning-persister](./lightning-persister)
53+
Utilities to manage Rust-Lightning channel data persistence and retrieval.
4454

4555
About
4656
-----------

0 commit comments

Comments
 (0)