Don't underpay htlc_min due to path contribution

[rust-lightning] / README.md

diff --git a/README.md b/README.md
index 943766940b3d7a328a14b0d0bd913ab1e8f43c40..d157b7368f91d1fdd8aa8d2a1ac9a72bdd13d8a6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,20 @@
+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 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 implements Lightning networking using the
+[Tokio](https://github.com/tokio-rs/tokio) async runtime.
 
-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
@@ -11,7 +22,7 @@ implementation has pretty good test coverage that is expected to continue to
 improve. There are a number of internal refactorings being done now that will
 make the code base more welcoming to new contributors. It is also anticipated
 that as developers begin using the API, the lessons from that will result in
-changes to the API, so any developer using LDK at this stage should be prepared
+changes to the API, so any developer using this API at this stage should be prepared
 to embrace that. The current state is sufficient for a developer or project to
 experiment with it. Recent increased contribution rate to the project is expected
 to lead to a high quality, stable, production-worthy implementation in 2020.
@@ -38,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
 ------------
 
@@ -46,6 +63,7 @@ Contributors are warmly welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
 Project Architecture
 ---------------------
 
-COMING SOON.
+For a Rust-Lightning high-level API introduction, see [ARCH.md](ARCH.md).
 
-License is Apache-2.0.
+License is either Apache-2.0 or MIT, at the option of the user (ie dual-license
+Apache-2.0 and MIT).