mempool: add module

examples/README.md

@@ -63,3 +63,9 @@ The commands in `shell.nix` allow you to locally run the node in a VM or contain
 
 Flakes make it easy to include `nix-bitcoin` in an existing NixOS config.
 The [flakes example](./flakes/flake.nix) shows how to use `nix-bitcoin` as an input to a system flake.
+
+### Extending nix-bitcoin with Flakes
+
+The [mempool extension flake](https://github.com/fort-nix/nix-bitcoin-mempool) shows how to define new
+pkgs and modules in a Flake.\
+Since mempool is now a core nix-bitcoin module, this Flake just serves as an example.

examples/configuration.nix

@@ -126,6 +126,26 @@
   # Automatically enables lightning-loop.
   # services.rtl.nodes.lnd.loop = true;
 
+  ### MEMPOOL
+  # Set this to enable mempool, a fully featured Bitcoin visualizer, explorer,
+  # and API service.
+  #
+  # services.mempool.enable = true;
+  #
+  # Possible options for the Electrum backend server:
+  #
+  # - electrs (enabled by default):
+  #   Small database size, slow when querying new addresses.
+  #
+  # - fulcrum:
+  #   Large database size, quickly serves arbitrary address queries.
+  #   Enable with:
+  #     services.mempool.electrumServer = "fulcrum";
+  #
+  # Set this to create an onion service to make the mempool web interface
+  # available via Tor:
+  # nix-bitcoin.onionServices.mempool-frontend.enable = true;
+
   ### ELECTRS
   # Set this to enable electrs, an Electrum server implemented in Rust.
   # services.electrs.enable = true;