Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BitcoinZavior authored May 5, 2023
1 parent 5b22c75 commit 50c6bf9
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down

0 comments on commit 50c6bf9

Please sign in to comment.