Revised lightning lib.rs

Author: Mateusz Faltyn

lightning/src/lib.rs

@@ -18,38 +18,27 @@
 //! generated/etc. This makes it a good candidate for tight integration into an existing wallet
 //! instead of having a rather-separate lightning appendage to a wallet.
 //! 
-//! Some of the features include: 
+//! Available features are: 
 //! 
-//! 1. Internal test utilities exposed to other repo crates:
-//! ```rust
-//! _test_utils = ["hex", "regex", "bitcoin/bitcoinconsensus"]
-//! ```
+//! 1. Skip logging of messages at levels below the given log level:
+//! * `max_level_off` 
+//! * `max_level_error`
+//! * `max_level_warn `
+//! * `max_level_info`
+//! * `max_level_debug`
+//! * `max_level_trace`
 //! 
-//! 2. Unlog messages superior at targeted level:
-//! ```rust
-//! max_level_off = []
-//! max_level_error = []
-//! max_level_warn = []
-//! max_level_info = []
-//! max_level_debug = []
-//! max_level_trace = []
-//! ```
+//! 2. Allow signing of local transactions that may have been revoked or will be revoked, 
+//! for functional testing (e.g. justice tx handling): 
+//! * `unsafe_revoked_tx_signing` - allows unsafe signing in dev code, such as functional testing of justice transactions outside our crate
+//! * `_bench_unstable` - allows test features for benching
+//! * `no-std ` - exposes write trait implementations from the `core2` crate
 //! 
-//! 3. Allow signing of local transactions that may have been revoked or will be revoked, for functional testing (e.g. justice tx handling). This is unsafe to use in production because it may result in the counterparty publishing taking our funds.
-//! ```rust
-//! unsafe_revoked_tx_signing = []
-//! _bench_unstable = []
+//! `default` features are: 
 //! 
-//! no-std = ["hashbrown", "bitcoin/no-std", "core2/alloc"]
-//! std = ["bitcoin/std"]
-//! ```
+//! * `std` - enables things which require `std`, including `std::io` trait implementations and things which utilize time
+//! * `grind_signatures` - enables generation of [low-r bitcoin signatures](https://bitcoin.stackexchange.com/questions/111660/what-is-signature-grinding), which saves 1 byte per signature in 50% of the cases (see [bitcoin PR #13666](https://github.com/bitcoin/bitcoin/pull/13666))
 //! 
-//! 4. Generate low-r bitcoin signatures, which saves 1 byte in 50% of the cases:
-//! ```rust
-//! grind_signatures = []
-//!
-//! default = ["std", "grind_signatures"]
-//! ```
 
 
 #![cfg_attr(not(any(test, fuzzing, feature = "_test_utils")), deny(missing_docs))]