X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=rust-lightning;a=blobdiff_plain;f=README.md;h=7dec713f637e23c5eb316c1ba56b7d6e93a9e724;hp=cd95cab29c33c00c02352c41baade314d2b9e480;hb=07db23d102738d1e84e3d2cb36101cef92e1761d;hpb=01b643399a2188f3db22f858f7ef402e6365a06a diff --git a/README.md b/README.md index cd95cab2..7dec713f 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,17 @@ implementation has pretty good test coverage that is expected to continue to improve. There are a number of internal refactorings being done now that will make the code base more welcoming to new contributors. It is also anticipated that as developers begin using the API, the lessons from that will result in -changes to the API, so any developer using LDK at this stage should be prepared +changes to the API, so any developer using this API at this stage should be prepared to embrace that. The current state is sufficient for a developer or project to experiment with it. Recent increased contribution rate to the project is expected to lead to a high quality, stable, production-worthy implementation in 2020. +Communications for Rust-Lightning and Lightning Development Kit happens through +[LDK slack](http://lightningdevkit.org/). + +Design Goal +----------- + The goal is to provide a full-featured but also incredibly flexible lightning implementation, allowing the user to decide how they wish to use it. With that in mind, everything should be exposed via simple, composable APIs. The user @@ -32,8 +38,14 @@ non-optional/non-test/non-library dependencies. Really really do not add dependencies with dependencies. Do convince Andrew to cut down dependency usage in rust-bitcoin. -Notes on coding style: - * Use tabs. If you want to align lines, use spaces. Any desired alignment - should display fine at any tab-length display setting. +Contributing +------------ + +Contributors are warmly welcome, see [CONTRIBUTING.md](CONTRIBUTING.md). + +Project Architecture +--------------------- + +For a Rust-Lightning high-level API introduction, see [ARCH.md](ARCH.md). License is Apache-2.0.