X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=b8807aad57873e45920b41d5b401226789c95791;hb=2c8222269376f6c7a4e73acf7e68d163d0758a0f;hp=6a9369ea9b8ca8a7e35ace4a261f5cc0e0d38090;hpb=8ec816e72af4a0c715492af6f720c5147adab01e;p=rust-lightning diff --git a/README.md b/README.md index 6a9369ea..b8807aad 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ +[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/) + Rust-Lightning, not Rusty's Lightning! +===== + +Documentation can be found at [docs.rs](https://docs.rs/lightning/) -Currently somewhere near 10% 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. 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