From: valentinewallace Date: Mon, 14 Feb 2022 18:01:55 +0000 (-0500) Subject: Merge pull request #1305 from ConorOkus/update-readme X-Git-Tag: v0.0.105~15 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=482d718e27ef9229747eb2d2d9b6dab01cf5e23f;p=rust-lightning Merge pull request #1305 from ConorOkus/update-readme Update README to include community invite links --- 482d718e27ef9229747eb2d2d9b6dab01cf5e23f diff --cc README.md index ea1f08ae1,bebbe68d6..dad0b3924 --- a/README.md +++ b/README.md @@@ -30,27 -30,9 +30,27 @@@ sufficient for a developer or project t 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 ----------- LDK/Rust-Lightning is a generic library which allows you to build a lightning