From 3f59b9bdc77b96909a17d026f8a2760f51d26854 Mon Sep 17 00:00:00 2001
From: G8XSU <3442979+G8XSU@users.noreply.github.com>
Date: Wed, 4 Dec 2024 13:30:15 -0800
Subject: [PATCH 1/3] Add Basic project description and README.md

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b60334f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# LDK-Server
+
+**LDK-Server** is a fully-functional Lightning node in daemon form, built on top of
+[LDK-Node](https://github.com/lightningdevkit/ldk-node), which itself provides a powerful abstraction over the
+[Lightning Development Kit (LDK)](https://github.com/lightningdevkit/rust-lightning) and uses an in-built
+[Bitcoin Development Kit (BDK)](https://bitcoindevkit.org/) wallet.
+
+The primary goal of **LDK-Server** is to provide an efficient, stable, and API-first solution for deploying and managing
+a Lightning Network node. With its streamlined setup, **LDK-Server** enables users to easily set up, configure, and run
+a Lightning node while exposing a robust, language-agnostic API via [Protocol Buffers (Protobuf)](https://protobuf.dev/).
+
+### Features
+
+- **Out-of-the-Box Lightning Node**:
+    - Deploy a Lightning Network node with minimal configuration, no coding required.
+
+- **API-First Design**:
+    - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
+
+- **Powered by LDK**:
+    - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
+
+- **Effortless Integration**:
+    - Ideal for embedding Lightning functionality into payment processors, self-hosted nodes, custodial wallets, or other Lightning-enabled
+      applications.
+
+### Project Status
+
+🚧 **Work in Progress**:
+- **APIs Under Development**: Expect breaking changes as the project evolves.
+- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
+- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary(specially for CLI), and usability improvements are actively being worked on.
+- **Pending Testing**: Not tested, hence don't use it for production!
+
+We welcome your feedback and contributions to help shape the future of LDK-Server!
+
+
+### Configuration
+Refer `./ldk-server/ldk-server.config to see available configuration options.
+
+### Building
+```
+git clone https://github.com/lightningdevkit/ldk-server.git
+cargo build
+```
+
+### Running
+```
+cargo run --bin ldk-server ./ldk-server/ldk-server.config
+```
+
+Interact with the node using CLI:
+```
+./target/debug/ldk-server-cli -b localhost:3000 onchain-receive
+```

From d9ec04efe5ee17d0c253a354e7d4d0d32cae8414 Mon Sep 17 00:00:00 2001
From: G8XSU <3442979+G8XSU@users.noreply.github.com>
Date: Wed, 4 Dec 2024 13:52:16 -0800
Subject: [PATCH 2/3] fixup! Add Basic project description and README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b60334f9..60bde2a4 100644
--- a/README.md
+++ b/README.md
@@ -51,5 +51,5 @@ cargo run --bin ldk-server ./ldk-server/ldk-server.config
 
 Interact with the node using CLI:
 ```
-./target/debug/ldk-server-cli -b localhost:3000 onchain-receive
+./target/debug/ldk-server-cli -b localhost:3002 onchain-receive
 ```

From da97f3623a62a59dfaed2f66225dc570e0e40ac7 Mon Sep 17 00:00:00 2001
From: G8XSU <3442979+G8XSU@users.noreply.github.com>
Date: Wed, 4 Dec 2024 13:54:14 -0800
Subject: [PATCH 3/3] fixup! Add Basic project description and README.md

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 60bde2a4..91f80fe4 100644
--- a/README.md
+++ b/README.md
@@ -51,5 +51,6 @@ cargo run --bin ldk-server ./ldk-server/ldk-server.config
 
 Interact with the node using CLI:
 ```
-./target/debug/ldk-server-cli -b localhost:3002 onchain-receive
+./target/debug/ldk-server-cli -b localhost:3002 onchain-receive # To generate onchain-receive address.
+./target/debug/ldk-server-cli -b localhost:3002 help # To print help/available commands.
 ```