Skip to content

Commit e48f8e3

Browse files
authored
Merge pull request #729 from casey/readme
Add content to readme
2 parents 8fb4a3d + 1c118ed commit e48f8e3

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
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 Bitcoin Lightning library written in Rust. The main crate,
9+
`lightning`, does not handle networking, persistence, or any other I/O. Thus,
10+
it is runtime-agnostic, but users must implement basic networking logic, chain
11+
interactions, and disk storage.
12+
13+
The `lightning-net-tokio` crate implements Lightning networking using the
14+
[Tokio](https://github.com/tokio-rs/tokio) async runtime.
515

6-
Documentation can be found at [docs.rs](https://docs.rs/lightning/)
16+
Status
17+
------
718

819
The project implements all of the BOLT specifications in the 1.0 spec except
920
for [channel queries](https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#query-messages). The
@@ -38,6 +49,12 @@ non-optional/non-test/non-library dependencies. Really really do not add
3849
dependencies with dependencies. Do convince Andrew to cut down dependency usage
3950
in rust-bitcoin.
4051

52+
53+
Tagline
54+
-------
55+
56+
*"Rust-Lightning, not Rusty's Lightning!"*
57+
4158
Contributing
4259
------------
4360

0 commit comments

Comments
 (0)