Add initial README and crate-level docs #49
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tnull
force-pushed
the
2023-03-add-readme-crate-docs
branch
2 times, most recently
from
5967ecb to
0df678a
Compare
tnull
force-pushed
the
2023-03-add-readme-crate-docs
branch
from
0df678a to
cafdda2
Compare
|
Looks like a good initial write-up to me. |
jkczyz
reviewed
Mar 21, 2023
README.md
Outdated
| A ready-to-go node implementation built using LDK. | ||
| 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 in library form. Its central goal is to provide a small, simple, and straightforward interface that enables users to easily setup 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. |
There was a problem hiding this comment.
@moneyball Any opinion on self-custodial vs non-custodial?
There was a problem hiding this comment.
I don't feel strongly about it. Non-custodial is fine.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.