Skip to content

Commit 85862f5

Browse files
committed
Drop open_announced_channel from README
.. as we generally want to ~discourage users from arbitrarily opening announced channels. They really only should do so if they are willing and able to run a proper 24/7 forwarding node. And node operators will likely know what to look for in the API.
1 parent 534b1ac commit 85862f5

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

README.md

+1-1
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`, `open_channel`, `open_announced_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`, `send`, etc.
1515

1616
```rust
1717
use ldk_node::Builder;

src/lib.rs

+1-3
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@
2020
//!
2121
//! The primary abstraction of the library is the [`Node`], which can be retrieved by setting up
2222
//! and configuring a [`Builder`] to your liking and calling [`build`]. `Node` can then be
23-
//! controlled via commands such as [`start`], [`stop`], [`open_channel`], [`open_announced_channel`]
24-
//! [`send`], etc.:
23+
//! controlled via commands such as [`start`], [`stop`], [`open_channel`], [`send`], etc.:
2524
//!
2625
//! ```no_run
2726
//! use ldk_node::Builder;
@@ -64,7 +63,6 @@
6463
//! [`start`]: Node::start
6564
//! [`stop`]: Node::stop
6665
//! [`open_channel`]: Node::open_channel
67-
//! [`open_announced_channel`]: Node::open_announced_channel
6866
//! [`send`]: Bolt11Payment::send
6967
//!
7068
#![cfg_attr(not(feature = "uniffi"), deny(missing_docs))]

0 commit comments

Comments
 (0)