mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-01-19 05:43:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Reword first paragraph and add tagline

Browse Source
This commit is contained in:
Casey Rodarmor 2020-10-01 20:28:41 -07:00
parent 0393b00478
commit 7c07ca0056
No known key found for this signature in database
GPG Key ID: 556186B153EC6FE0
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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
------------