X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=d157b7368f91d1fdd8aa8d2a1ac9a72bdd13d8a6;hb=18c773004062410851e68fe944226f8c3255bf17;hp=a6f5268e5094f3cb8185c50b8796144e8d3e5e52;hpb=22a0dd5f339058fd6733920ffca0f5eb64db4e32;p=rust-lightning diff --git a/README.md b/README.md index a6f5268e..d157b736 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ +Rust-Lightning +============== + +[![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning) +[![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/) [![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! -===== +Rust-Lightning is a Bitcoin Lightning library written in Rust. The main crate, +`lightning`, does not handle networking, persistence, or any other I/O. Thus, +it is runtime-agnostic, but users must implement basic networking logic, chain +interactions, and disk storage. + +The `lightning-net-tokio` crate implements Lightning networking using the +[Tokio](https://github.com/tokio-rs/tokio) async runtime. -Documentation can be found at [docs.rs](https://docs.rs/lightning/) +Status +------ 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 @@ -38,6 +49,12 @@ 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. + +Tagline +------- + +*"Rust-Lightning, not Rusty's Lightning!"* + Contributing ------------