Add Basic project description and README.md #29
Conversation
G8XSU
commented
Dec 4, 2024
•
G8XSU
commented
- Add basic project description and README.md
| 🚧 **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. |
There was a problem hiding this comment.
Should we already speak about more of the planned features, e.g., LSP service integration? Or rather not to not spill the beans just yet?
There was a problem hiding this comment.
There are many features planned or upcoming. I didn't mention those because it wouldn't be exhaustive.
This list only includes stability/critical list for general readiness. 😅
As in what is required to get out of "wip" 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. |
| ### Features | ||
|
|
||
| - **Out-of-the-Box Lightning Node**: | ||
| - Deploy a Lightning Network node with minimal configuration, no coding required. |
There was a problem hiding this comment.
Not sure if it should be mentioned here or elsewhere, but might be worth stating what can be configured somewhere.
There was a problem hiding this comment.
It is mentioned in "Configuration" section right before ## building
There was a problem hiding this comment.
I mean at a more high-level like you can provide your own KvStore, etc.
There was a problem hiding this comment.
Fine to leave out now if we don't have a way of configuring that, of course.
There was a problem hiding this comment.
We can't configure kvstore right now without forking
|
This PR got closed because of me deleting the fork of private repo. |
