mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-02-25 07:17:40 +01:00
commit
e48f8e3f33
1 changed files with 20 additions and 3 deletions
23
README.md
23
README.md
|
@ -1,9 +1,20 @@
|
|||
Rust-Lightning
|
||||
==============
|
||||
|
||||
[](https://crates.io/crates/lightning)
|
||||
[](https://docs.rs/lightning/)
|
||||
[](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.
|
||||
|
||||
Documentation can be found at [docs.rs](https://docs.rs/lightning/)
|
||||
The `lightning-net-tokio` crate implements Lightning networking using the
|
||||
[Tokio](https://github.com/tokio-rs/tokio) async runtime.
|
||||
|
||||
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
|
||||
|
@ -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
|
||||
------------
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue