Skip to content

Commit 8cbec31

Browse files
Merge pull request #16 from jkczyz/2021-02-architecture-reference
Add reference to LDK architecture
2 parents 7e0b041 + 7ebd679 commit 8cbec31

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/references.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,23 @@ id: references
33
title: References
44
---
55

6-
* Rust documentation: https://docs.rs/lightning/0.0.12/lightning/index.html
6+
### [Rust Documentation](https://docs.rs/lightning)
7+
78
These provide the most searchable and comprehensive documentation on LDK.
89
If you're using Java and want more information on any method/struct/etc., searching
910
the Rust docs for the Rust version of that struct/method is your best bet.
1011

11-
* Rust sample node: https://github.com/TheBlueMatt/rust-lightning-bitcoinrpc
12+
### [Rust Sample Node](https://github.com/TheBlueMatt/rust-lightning-bitcoinrpc)
13+
1214
While this node is a little outdated, it's still a very useful reference for how to construct
1315
a lightning node using LDK.
1416

15-
* Swift LDK documentation: https://github.com/arik-so/SwiftLightning/tree/master/Documentation
17+
### [Swift LDK Documentation](https://github.com/arik-so/SwiftLightning/tree/master/Documentation)
18+
1619
These docs are mainly geared towards how Swift could call LDK C bindings directly, but still may
1720
provide a useful overview of Rust Lightning in the context of language bindings.
21+
22+
### [LDK Architecture](https://docs.google.com/drawings/d/1Ql-q5gyrPnJhi7z_D39jayG0HEEVh6UEY1eULXb03Eg/edit?usp=sharing)
23+
24+
Gives a high-level organization of LDK and how the pieces fit together. Variations of this diagram
25+
are used throughout the site. This is the primary source and is still a work in progress.

0 commit comments

Comments
 (0)