Skip to content

Commit 059a30e

Browse files
committed
docs: cleanup documentation
1 parent 32e7096 commit 059a30e

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A ready-to-go Lightning node library built using [LDK][ldk] and [BDK][bdk].
1111
LDK Node is a self-custodial Lightning node in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily set up and run a Lightning node with an integrated on-chain wallet. While minimalism is at its core, LDK Node aims to be sufficiently modular and configurable to be useful for a variety of use cases.
1212

1313
## Getting Started
14-
The primary abstraction of the library is the [`Node`][api_docs_node], which can be retrieved by setting up and configuring a [`Builder`][api_docs_builder] to your liking and calling one of the `build` methods. `Node` can then be controlled via commands such as `start`, `stop`, `connect_open_channel`, `send`, etc.
14+
The primary abstraction of the library is the [`Node`][api_docs_node], which can be retrieved by setting up and configuring a [`Builder`][api_docs_builder] to your liking and calling one of the `build` methods. `Node` can then be controlled via commands such as `start`, `stop`, `open_channel`, `open_announced_channel`, `send`, etc.
1515

1616
```rust
1717
use ldk_node::Builder;
@@ -37,7 +37,7 @@ fn main() {
3737

3838
let node_id = PublicKey::from_str("NODE_ID").unwrap();
3939
let node_addr = SocketAddress::from_str("IP_ADDR:PORT").unwrap();
40-
node.connect_open_channel(node_id, node_addr, 10000, None, None, false).unwrap();
40+
node.open_channel(node_id, node_addr, 10000, None, None).unwrap();
4141

4242
let event = node.wait_next_event();
4343
println!("EVENT: {:?}", event);
@@ -60,9 +60,6 @@ LDK Node currently comes with a decidedly opinionated set of design choices:
6060
- Gossip data may be sourced via Lightning's peer-to-peer network or the [Rapid Gossip Sync](https://docs.rs/lightning-rapid-gossip-sync/*/lightning_rapid_gossip_sync/) protocol.
6161
- Entropy for the Lightning and on-chain wallets may be sourced from raw bytes or a [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic. In addition, LDK Node offers the means to generate and persist the entropy bytes to disk.
6262

63-
**Note**:
64-
Regarding node announcements, we have decided not to broadcast these announcements if either the node's listening addresses or its node alias are not set.
65-
6663
## Language Support
6764
LDK Node itself is written in [Rust][rust] and may therefore be natively added as a library dependency to any `std` Rust program. However, beyond its Rust API it also offers language bindings for [Swift][swift], [Kotlin][kotlin], and [Python][python] based on the [UniFFI](https://github.com/mozilla/uniffi-rs/). Moreover, [Flutter bindings][flutter_bindings] are also available.
6865

0 commit comments

Comments
 (0)