Add notes to docs/README to indicate beta status of service-side

As a few things are missing (most importantly persistence), we add notes that the service-side integration is currently considered 'beta'.
lightningdevkit · Dec 19, 2024 · dd91418 · dd91418
1 parent 6e06262
commit dd91418
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/lightning-liquidity/README.md b/lightning-liquidity/README.md
@@ -2,6 +2,9 @@
 
 The goal of this crate is to provide types and primitives to integrate a spec-compliant LSP with an LDK-based node. To this end, this crate provides client-side as well as service-side logic to implement the [LSP specifications].
 
+**Note**: Service-side support is currently considered "beta", i.e., not fully
+ready for production use.
+
 Currently the following specifications are supported:
 - [LSPS0] defines the transport protocol with the LSP over which the other protocols communicate.
 - [LSPS1] allows to order Lightning channels from an LSP. This is useful when the client needs

diff --git a/lightning-liquidity/src/lib.rs b/lightning-liquidity/src/lib.rs
@@ -10,6 +10,9 @@
 
 //! The goal of this crate is to provide types and primitives to integrate a spec-compliant LSP with an LDK-based node. To this end, this crate provides client-side as well as service-side logic to implement the [LSP specifications].
 //!
+//! **Note**: Service-side support is currently considered "beta", i.e., not fully ready for
+//! production use.
+//!
 //! Currently the following specifications are supported:
 //! - [LSPS0] defines the transport protocol with the LSP over which the other protocols communicate.
 //! - [LSPS1] allows to order Lightning channels from an LSP. This is useful when the client needs