Skip to content

Commit 8be7555

Browse files
committed
f Nits
1 parent 25ff46f commit 8be7555

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

README.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,16 @@ section.
1313

1414
Status
1515
------
16-
The project implements all of the [BOLT specifications](https://github.com/lightning/bolts) in the
17-
1.0 spec. The implementation has pretty good test coverage that is expected to continue to improve.
18-
It is also anticipated that as developers begin using the API, the lessons from that will result in
19-
changes to the API, so any developer using this API at this stage should be prepared to embrace
20-
that. The current state is sufficient for a developer or project to experiment with it.
16+
The project implements all of the [BOLT
17+
specifications](https://github.com/lightning/bolts) in the spec. The
18+
implementation has pretty good test coverage that is expected to continue to
19+
improve. It is also anticipated that as developers begin using the API, the
20+
lessons from that will result in changes to the API, so any developer using this
21+
API at this stage should be prepared to embrace that. The current state is
22+
sufficient for a developer or project to experiment with it.
2123

22-
Communications for Rust-Lightning and Lightning Development Kit happens through our LDK
23-
[Discord](https://discord.gg/5AcknnMfBw) channels.
24+
Communications for Rust-Lightning and Lightning Development Kit happens through
25+
our LDK [Discord](https://discord.gg/5AcknnMfBw) channels.
2426

2527
Crates
2628
-----------
@@ -51,17 +53,19 @@ node without needing to worry about getting all of the Lightning state machine,
5153
routing, and on-chain punishment code (and other chain interactions) exactly
5254
correct. Note that Rust-Lightning isn't, in itself, a node. There are various
5355
working/in progress demos which could be used as a node today, but if you "just"
54-
want a generic Lightning node, you're almost certainly better off with
55-
[Core Lightning](https://github.com/ElementsProject/lightning) or
56-
[LND](https://github.com/lightningnetwork/lnd) - if, on the other hand, you want to integrate
57-
Lightning with custom features such as your own chain sync, your own key management, your
58-
own data storage/backup logic, etc., LDK is likely your only option. Some
59-
Rust-Lightning utilities such as those in [`chan_utils`](./lightning/src/ln/chan_utils.rs) are also
60-
suitable for use in non-LN Bitcoin applications such as DLCs and bulletin boards.
61-
62-
A sample node which fetches blockchain data and manages on-chain funds via the Bitcoin Core
63-
RPC/REST interface is available [here](../ldk-sample). The individual pieces of that demo are be
64-
composable, so you can pick the off-the-shelf parts you want and replace the rest.
56+
want a generic Lightning node, you're almost certainly better off with [Core
57+
Lightning](https://github.com/ElementsProject/lightning) or
58+
[LND](https://github.com/lightningnetwork/lnd) - if, on the other hand, you want
59+
to integrate Lightning with custom features such as your own chain sync, your
60+
own key management, your own data storage/backup logic, etc., LDK is likely your
61+
only option. Some Rust-Lightning utilities such as those in
62+
[`chan_utils`](./lightning/src/ln/chan_utils.rs) are also suitable for use in
63+
non-LN Bitcoin applications such as DLCs and bulletin boards.
64+
65+
A sample node which fetches blockchain data and manages on-chain funds via the
66+
Bitcoin Core RPC/REST interface is available [here](../ldk-sample). The
67+
individual pieces of that demo are be composable, so you can pick the
68+
off-the-shelf parts you want and replace the rest.
6569

6670
In general, Rust-Lightning does not provide (but LDK has implementations of):
6771
* on-disk storage - you can store the channel state any way you want - whether

0 commit comments

Comments
 (0)