X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=dad0b39241576094ed5fe45d601d000bd0c3516d;hb=refs%2Fheads%2F2021-07-par-gossip-processing;hp=d73e71da8aaf3a10fa076ca6fc953f6949094c78;hpb=151d4ac0a3a6aa94d3f93995b71c874b7ea95967;p=rust-lightning diff --git a/README.md b/README.md index d73e71da..dad0b392 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,26 @@ 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 2021. -Communications for Rust-Lightning and Lightning Development Kit happens through -[LDK slack](http://lightningdevkit.org/). +Communications for Rust-Lightning and Lightning Development Kit happens through our LDK +[slack](https://join.slack.com/t/lightningdevkit/shared_invite/zt-tte36cb7-r5f41MDn3ObFtDu~N9dCrQ) & [discord](https://discord.gg/5AcknnMfBw) channels. + +Crates +----------- +1. [lightning](./lightning) + The Core of the LDK library, implements the lightning protocol, channel state machine, + and on-chain logic. Supports no-std and exposes on relatively low-level interfaces. +2. [lightning-background-processor](./lightning-background-processor) + Utilities to perform required background tasks for Rust Lightning. +3. [lightning-block-sync](./lightning-block-sync) + Utilities to fetch the chain data from a block source and feed them into Rust Lightning. +4. [lightning-invoice](./lightning-invoice) + Data structures to parse and serialize BOLT11 lightning invoices. +5. [lightning-net-tokio](./lightning-net-tokio) + Implementation of the rust-lightning network stack using Tokio. + For Rust-Lightning clients which wish to make direct connections to Lightning P2P nodes, + this is a simple alternative to implementing the required network stack, especially for those already using Tokio. +6. [lightning-persister](./lightning-persister) + Utilities to manage Rust-Lightning channel data persistence and retrieval. About ----------- @@ -87,7 +105,7 @@ In general, Rust-Lightning does not provide (but LDK has implementations of): hardware wallets. LDK's customizability was presented about at Advancing Bitcoin in February 2020: -https://vimeo.com/showcase/7131712/video/418412286 +https://vimeo.com/showcase/8372504/video/412818125 Design Goal -----------