From 8a818c66a063e9c2e8fe4eab86841e902fb76cfa Mon Sep 17 00:00:00 2001 From: Djuri Baars Date: Sat, 21 Dec 2024 01:15:59 +0100 Subject: [PATCH] Update readme --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 71d3319..1962434 100644 --- a/README.md +++ b/README.md @@ -16,21 +16,21 @@ Biggest differences with v2 are: New features: - BitAxe integration -- Zap notifier -- Braiins Pool and Ocean mining stats integration +- Nostr Zap notifier +- Multiple mining pool stats integrations "Steal focus on new block" means that when a new block is mined, the display will switch to the block height screen if it's not on it already. -Most [information](https://github.com/btclock/btclock_v2/wiki) about BTClock v2 is still valid for this version. +See the [docs](https://git.btclock.dev/btclock/docs) repo for more information and building instructions. **NOTE**: The software assumes that the hardware is run in a controlled private network. ~~The Web UI and the OTA update mechanism are not password protected and accessible to anyone in the network. Also, since the device only fetches numbers through WebSockets it will skip server certificate verification to save resources.~~ Since 3.2.0 the WebUI is password protectable and all certificates are verified. OTA update mechanism is not password-protected. ## Building -Use PlatformIO to build it yourself. Make sure you fetch the [WebUI](https://github.com/btclock/webui) submodule. +Use PlatformIO to build it yourself. Make sure you fetch the [WebUI](https://git.btclock.dev/btclock/webui) submodule. -## Braiins Pool and Ocean integration +## Mining pool stats Enable mining pool stats by accessing your btclock's web UI (point a web browser at the device's IP address). Under Settings -> Extra Features: toggle Enable Mining Pool Stats. @@ -41,6 +41,8 @@ The Mining Pool Earnings screen displays: * Braiins: Today's mining reward thus far * Ocean: Your estimated earnings if the pool were to find a block right now +For solo mining pools, there are no earning estimations. Your username is the onchain withdrawal address, without the worker name. + ### Braiins Pool integration Create an API key based on the steps [here](https://academy.braiins.com/en/braiins-pool/monitoring/#api-configuration).