chore: update variable names & provide clarity on features in readme #178
Conversation
This file contains 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
In the README, example variable names for `lndk.conf` were incorrect. They need to be snake_case rather than kebab-case. Specifically: `cert-path` --> `cert_path` `macaroon-path` --> `macaroon_path` This commit updates the README with the proper variable names. Additionally, this commit changes the wording for clarity by specifying LNDK "features" rather than "options".
Closed
dunxen
changed the title
|
Apologies for only getting to this now. It fell off my radar due to travel. I see this obsoletes #177. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #178 +/- ##
======================================
Coverage 0.00% 0.00%
======================================
Files 1 1
Lines 126 126
======================================
Misses 126 126 ☔ View full report in Codecov by Sentry. |
dunxen
approved these changes
Oct 9, 2024
| @@ -3,15 +3,17 @@ | |||
| LNDK is a standalone daemon that connects to [LND](https://github.com/lightningnetwork/lnd) (via its grpc API) that aims to implement [bolt 12](https://github.com/lightning/bolts/pull/798) functionality _externally_ to LND. LNDK leverages the [lightning development kit](https://github.com/lightningdevkit/rust-lightning) to provide functionality, acting as a thin "shim" between LND's APIs and LDK's lightning library. | |||
|
|
|||
| Project Milestones: | |||
|
|
|||
There was a problem hiding this comment.
These newlines after headings have no effect on the rendered markdown, but it does make the source more readable 👍
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.
In the README, example variable names for
lndk.confwere incorrect. They need to be snake_case rather than kebab-case.Specifically:
cert-path-->cert_pathmacaroon-path-->macaroon_pathThis commit updates the README with the proper variable names.
Additionally, this commit changes the wording for clarity by specifying LNDK "features" rather than "options".