X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=f8de40f3193af3fa2fb0be80799b320e0391ff7b;hb=refs%2Fheads%2Fupstream%2Fmain;hp=824a2875b6331a51d293f47aaaa2f83c3fada7ee;hpb=2fda791d5c36863ca69b290c9293db2fe0d35a25;p=rust-lightning diff --git a/README.md b/README.md index 824a2875..f8de40f3 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,9 @@ Rust-Lightning [![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning) [![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/) [![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/) +[![Security Audit](https://github.com/lightningdevkit/rust-lightning/actions/workflows/audit.yml/badge.svg)](https://github.com/lightningdevkit/rust-lightning/actions/workflows/audit.yml) -[LDK](https://lightningdevkit.org)/`rust-lightning` is a highly performant and flexible +[LDK](https://lightningdevkit.org)/`rust-lightning` is a highly performant and flexible implementation of the Lightning Network protocol. The primary crate, `lightning`, is runtime-agnostic. Data persistence, chain interactions, @@ -94,7 +95,7 @@ In general, `rust-lightning` does not provide (but LDK has implementations of): wanted to run your full Lightning node on a hardware wallet, you could, by piping the Lightning network messages over USB/serial and then sending them in a TCP socket from another machine. -* private keys - again we have "default implementations", but users can chose to +* private keys - again we have "default implementations", but users can choose to provide private keys to RL/LDK in any way they wish following a simple API. We even support a generic API for signing transactions, allowing users to run RL/LDK without any private keys in memory/putting private keys only on @@ -105,8 +106,8 @@ https://vimeo.com/showcase/8372504/video/412818125 Design Goal ----------- -The goal is to provide a full-featured but also incredibly flexible Lightning -implementation, allowing the user to decide how they wish to use it. With that +The goal is to provide a fully-featured and incredibly flexible Lightning +implementation, allowing users to decide how they wish to use it. With that in mind, everything should be exposed via simple, composable APIs. More information about `rust-lightning`'s flexibility is provided in the `About` section above.