From 50c6bf9cf1065731b5060bcae931c6209821027a Mon Sep 17 00:00:00 2001 From: Bitcoin Zavior <93057399+BitcoinZavior@users.noreply.github.com> Date: Fri, 5 May 2023 06:54:19 -0400 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c89d146..0f8428b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ A Flutter library for [LDK Node](https://github.com/lightningdevkit/ldk-node), a ready-to-go Lightning node library built using [LDK](https://lightningdevkit.org) and [BDK](https://bitcoindevkit.org). +LDK Node is a non-custodial Lightning node. 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. + +The primary abstraction of the library is the Node, which can be retrieved by setting up and configuring a Builder to your liking and calling build(). Node can then be controlled via commands such as start, stop, connectOpen_channel, sendPayment, etc.: ### How to use ldk_node @@ -11,7 +14,7 @@ To use the `ldk_node` package in your project, add it as a dependency in your pr dependencies: ldk_node: ^0.1.0 ``` -or run this command +or add from pub.dev using `pub add` command ``` flutter pub add ldk_node