]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add content to readme
authorCasey Rodarmor <casey@rodarmor.com>
Fri, 2 Oct 2020 02:34:02 +0000 (19:34 -0700)
committerCasey Rodarmor <casey@rodarmor.com>
Fri, 2 Oct 2020 02:36:17 +0000 (19:36 -0700)
- Change header to "Rust-Lightning"
- Add crate and documentation badges
- Add introductory paragraph
- Move previous intro content under "Status" heading

README.md

index a6f5268e5094f3cb8185c50b8796144e8d3e5e52..b836ada3713e4e9197fa4702b747fbfb279df6c7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,17 @@
+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 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.
 
-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