chore: re-write README

Author: dr-orlovsky

README.md

@@ -1,58 +1,75 @@
 # BP Node
 
-Bitcoin blockchain indexing and wallet notification node. It may be considered
-electrum server replacement, which is faster, provides modern API (supporting
-wallet descriptors, LN-specific queries, client-side-validation tech like RGB,
-modern RPC subscribe interfaces).
-
-The node was originally designed and implemented by 
-[Dr Maxim Orlovsky](https://github.com/dr-orlovsky) as a part of 
-[LNP/BP Standards Association](https://github.com/LNP-BP) effort for 
-building the foundation for LNP/BP layer 2 and 3 bitcoin application ecosystem.
-It is based on other LNP/BP projects such as [BP Core Lib], [BP Standard Lib],
-[BP Wallet Lib] and can be easily integrated with the rest of LNP/BP nodes like
-[LNP Node], [RGB Node], [Storm Node].
-
-In the future it is planned to upgrade the node into a fully-validating bitcoin
-node by using [`bitcoinkernel`] library for validating blocks.
-
-## Node services
-
-The node organized as a set of threads, interacting via crossbeam API with each
-other -- and via [Strict RPC] with connecting clients. It leverages microservice
-architecture with [I/O Reactor] (used instead of async), authentication with
-self-sovereign identities ([SSI]) and end-to-end encryption from [Cyphernet]
-crates.
-
-The node provides following set of services:
-- `bpd`: main service providing clients with RPC request/reply API and managing
-  life cycle of the rest of the node services (launching, terminating, brokering
-  inter-service communications).
-- `blockd`: service parsing and (in the future, using `bitcoinkernel`) 
-  validating bitcoin blocks, storing them in the database.
-- `mempoold`: manages mempool transactions.
-- `walletd`: service instantiated for each wallet client. It knows about wallet
-  descriptor, monitors new mempool and mined transactions and notifies 
-  subscribed client about their changes.
-- `watchd`: watchtower service for lightning network and RGB.
-- `listend`: interface listening to Bitcoin Core or an external indexing service
-  (like Esplora), if one is used.
-
-## RPC and client tools
-
-The repository also contains a BP Node RPC library (`bp-rpc` crate in 
-[`rpc`](./rpc) directory) and command-line tool (`bp-cli` crate in 
-[`cli`](./client) directory) for querying/working with the node.
+![Build](https://github.com/BP-WG/bp-node/workflows/Build/badge.svg)
+![Lints](https://github.com/BP-WG/bp-node/workflows/Lints/badge.svg)
+[![Apache-2 licensed](https://img.shields.io/crates/l/bp-node)](./LICENSE)
+
+Bitcoin blockchain indexing and wallet notification node. It may be considered Electrum server or
+Esplora replacement, being faster, providing modern binary API, supporting wallet descriptors,
+LN-specific queries, client-side-validation tech like RGB, modern publication-subscribe interfaces,
+Noise encryption in network connectivity, asymmetric cryptographic client authentication and many
+more.
+
+The node designed and implemented by [Dr Maxim Orlovsky](https://github.com/dr-orlovsky) as a part
+of [LNP/BP Labs](https://github.com/LNP-BP) effort in building the foundation for LNP/BP layer 2 and
+3 bitcoin application ecosystem. It is based on other LNP/BP projects such as [BP Core Lib],
+[BP Standard Lib], [BP Wallet Lib] and can be easily integrated with the rest of LNP/BP nodes like
+[LNP Node].
+
+In the future it is planned to upgrade the node into a fully-validating bitcoin node by using
+[`bitcoinkernel`] library for validating blocks.
+
+## Components
+
+This repository contains the following crates:
+
+- `bp-node`: main indexing daemon, which can be used as an embedded multi-thread service, or
+  compiled into a standalone binary (`bpd`);
+- `bp-client`: client to work with the daemon and a command-line utility `bp-cli`;
+- `bp-rpc`: a shared crate between `bp-node` and `bp-client`.
+
+## Node Architecture
+
+The node operates as a set of threads, communicating through Crossbeam channels. It leverages
+[`microservices.rs`] and [`netservices.rs`] crates, which serves as the node non-blocking
+reactor-based (see [`io-reactor`]) microservice frameworks.
+
+The node daemon has the following components:
+
+- **RPC**: reactor-based thread managing incoming client connections, notifying them about changes
+  to the subscribed information;
+- **Block importer**: a client connecting an integration service (see below) to bitcoin blockchain
+  provider (Bitcoin Core, other Bitcoin nodes or indexers) receiving downloaded and new blocks;
+- **Block processor**, a worker pool parsing new blocks coming from the integrated providers into
+  database;
+- **Persistence**, an embedded ReDB database;
+- **Query worker pool**, running queries for the client subscriptions in the database.
+
+In order to operate one also needs to provide a node with an interface to bitcoin blocks integrating
+it with either Bitcoin Core, or any other node or indexer.
+
+By default, the node exposes a binary RPC API over TCP, which can be exposed as more high-level APIs
+(HTTP REST, Websocket-based or JSON-RPC) using special adaptor services.
+
+## OS Support
+
+The project currently supports only Linux and UNIX OSes. Support for macOS is currently broken due
+to use of a Rust language unstable feature on macOS platform by one of the project dependencies, and
+will be recovered soon. Windows support is a work-in-progress, requiring downstream [`io-reactor`]
+framework changes.
 
 [`bitcoinkernel`]: https://github.com/bitcoin/bitcoin/issues/27587
+
 [BP Core Lib]: https://github.com/BP-WG/bp-core
+
 [BP Standard Lib]: https://github.com/BP-WG/bp-std
+
 [BP Wallet Lib]: https://github.com/BP-WG/bp-wallet
+
 [LNP Node]: https://github.com/LNP-WG/lnp-node
-[RGB Node]: https://github.com/RGB-WG/rgb-node
-[Storm Node]: https://github.com/Storm-WG/storm-node
 
-[SSI]: https://github.com/LNP-BP/SSI
-[Cyphernet]: https://github.com/cyphernet-labs
-[Strict RPC]: https://github.com/strict-types/strict-rpc
-[I/O Reactor]: https://github.com/rust-amplify/io-reactor
+[`io-reactor`]: https://github.com/rust-amplify/io-reactor
+
+[`microservices.rs`]: https://github.com/cyphernet-labs/microservices.rs
+
+[`netservices.rs`]: https://github.com/cyphernet-labs/netservices.rs