Skip to content

Commit a5a048e

Browse files
Fix outdated README sections
1 parent 00f08c9 commit a5a048e

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,17 @@ Rust-Lightning
55
[![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/)
66
[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
77

8-
`rust-lightning` is a Bitcoin Lightning library written in Rust. The main crate,
9-
`lightning`, does not handle networking, persistence, or any other I/O. Thus,
10-
it is runtime-agnostic, but users must implement basic networking logic, chain
11-
interactions, and disk storage. More information is available in the `About`
12-
section.
8+
[LDK](lightningdevkit.org)/`rust-lightning` is a highly performant implementation of the Lightning
9+
Network protocol, with support for custom data persistence, chain sync, and much more.
10+
11+
The main crate, `lightning`, does not handle networking, persistence, or any other I/O. Thus, it is
12+
runtime-agnostic, but users must plug in networking logic, chain interactions, and disk storage.
13+
More information is available in the [`About`](./README.md#about) section.
1314

1415
Status
1516
------
16-
The project implements all of the [BOLT
17-
specifications](https://github.com/lightning/bolts). 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.
17+
The project implements all of the [BOLT specifications](https://github.com/lightning/bolts),
18+
and has been in production use since early 2022.
2319

2420
Communications for `rust-lightning` and Lightning Development Kit happen through
2521
our LDK [Discord](https://discord.gg/5AcknnMfBw) channels.
@@ -55,10 +51,9 @@ LDK/`rust-lightning` is a generic library which allows you to build a Lightning
5551
node without needing to worry about getting all of the Lightning state machine,
5652
routing, and on-chain punishment code (and other chain interactions) exactly
5753
correct. Note that `rust-lightning` isn't, in itself, a node. There are various
58-
working/in progress demos which could be used as a node today, but if you "just"
59-
want a generic Lightning node, you're almost certainly better off with [Core
60-
Lightning](https://github.com/ElementsProject/lightning) or
61-
[LND](https://github.com/lightningnetwork/lnd). If, on the other hand, you want
54+
nodes built using LDK, but if you "just" want a generic Lightning node, you're almost
55+
certainly better off with [Core Lightning](https://github.com/ElementsProject/lightning)
56+
or [LND](https://github.com/lightningnetwork/lnd). If, on the other hand, you want
6257
to integrate Lightning with custom features such as your own chain sync, your
6358
own key management, your own data storage/backup logic, etc., LDK is likely your
6459
only option. Some `rust-lightning` utilities such as those in

0 commit comments

Comments
 (0)