Skip to content

Commit 0393b00

Browse files
committed
Add content to readme
- Change header to "Rust-Lightning" - Add crate and documentation badges - Add introductory paragraph - Move previous intro content under "Status" heading
1 parent 8fb4a3d commit 0393b00

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
Rust-Lightning
2+
==============
3+
4+
[![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning)
5+
[![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/)
16
[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)
27

3-
Rust-Lightning, not Rusty's Lightning!
4-
=====
8+
Rust-lightning is a low-level Bitcoin Lightning library written in Rust. It is
9+
low-level in that it does not handle networking, persistence, or any other I/O.
10+
Thus, it is runtime-agnostic, but users must implement basic networking logic,
11+
chain interactions, and disk storage.
512

6-
Documentation can be found at [docs.rs](https://docs.rs/lightning/)
13+
Status
14+
------
715

816
The project implements all of the BOLT specifications in the 1.0 spec except
917
for [channel queries](https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#query-messages). The

0 commit comments

Comments
 (0)