From: Casey Rodarmor <casey@rodarmor.com>
Date: Fri, 2 Oct 2020 02:34:02 +0000 (-0700)
Subject: Add content to readme
X-Git-Tag: v0.0.12~20^2~3
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=0393b00478f018b593966c50dfa3f12ea4175692;p=rust-lightning

Add content to readme

- Change header to "Rust-Lightning"
- Add crate and documentation badges
- Add introductory paragraph
- Move previous intro content under "Status" heading
---

diff --git a/README.md b/README.md
index a6f5268e..b836ada3 100644
--- 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