X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=rust-lightning;a=blobdiff_plain;f=README.md;h=7dec713f637e23c5eb316c1ba56b7d6e93a9e724;hp=460571f0070943da516720d588b386aa48d37b31;hb=HEAD;hpb=c779278bcf131fa5e7595f12aff4fd3218a7b7bf diff --git a/README.md b/README.md index 460571f0..7dec713f 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,22 @@ Rust-Lightning, not Rusty's Lightning! Documentation can be found at [docs.rs](https://docs.rs/lightning/) -Currently somewhere near 40% towards usable, published to see if there is any -real interest from folks in using a lightning rust library. +The project implements all of the BOLT specifications in the 1.0 spec except +for [channel queries](https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#query-messages). The +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 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 @@ -24,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.