From: Casey Rodarmor Date: Fri, 2 Oct 2020 03:28:41 +0000 (-0700) Subject: Reword first paragraph and add tagline X-Git-Tag: v0.0.12~20^2~2 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=7c07ca00563b0c533a8debc65720cc999053a0d2;p=rust-lightning Reword first paragraph and add tagline --- diff --git a/README.md b/README.md index b836ada3..4d0da8dd 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,13 @@ 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 low-level Bitcoin Lightning library written in Rust. It is -low-level in that it 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. +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 +[Tokio](https://github.com/tokio-rs/tokio) async runtime. Status ------ @@ -46,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 ------------