X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=d157b7368f91d1fdd8aa8d2a1ac9a72bdd13d8a6;hb=a044ba0667d0ca62d8a4e3c3b28605d66198ce7f;hp=4d0da8dd5372e82abf1e61efc7cbb0f1fd1ddb92;hpb=7c07ca00563b0c533a8debc65720cc999053a0d2;p=rust-lightning diff --git a/README.md b/README.md index 4d0da8dd..d157b736 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ Rust-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 is a Bitcoin Lightning library written in Rust. The main crate, +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 is a full Lightning using the +The `lightning-net-tokio` crate implements Lightning networking using the [Tokio](https://github.com/tokio-rs/tokio) async runtime. Status