Docs update; info on mining pool stats config
This commit is contained in:
parent
fabc6c1d28
commit
c3af0b4d36
1 changed files with 25 additions and 2 deletions
27
README.md
27
README.md
|
@ -17,7 +17,7 @@ Biggest differences with v2 are:
|
||||||
New features:
|
New features:
|
||||||
- BitAxe integration
|
- BitAxe integration
|
||||||
- Zap notifier
|
- Zap notifier
|
||||||
-
|
- Braiins Pool and Ocean mining stats integration
|
||||||
|
|
||||||
"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.
|
"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.
|
||||||
|
|
||||||
|
@ -27,4 +27,27 @@ Most [information](https://github.com/btclock/btclock_v2/wiki) about BTClock v2
|
||||||
|
|
||||||
## Building
|
## 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://github.com/btclock/webui) submodule.
|
||||||
|
|
||||||
|
|
||||||
|
## Braiins Pool and Ocean integration
|
||||||
|
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.
|
||||||
|
|
||||||
|
New options will appear. Select your mining pool and enter your pool username (Ocean) or api key (Braiins).
|
||||||
|
|
||||||
|
|
||||||
|
### Braiins Pool integration
|
||||||
|
Create an API key based on the steps [here](https://academy.braiins.com/en/braiins-pool/monitoring/#api-configuration).
|
||||||
|
|
||||||
|
The key's permissions should be:
|
||||||
|
* Web Access: no
|
||||||
|
* API Access: yes
|
||||||
|
* Access Permissions: Read-only
|
||||||
|
|
||||||
|
Copy the token that is created for the new key. Enter this as your "Mining Pool username or api key" in the btclock web UI.
|
||||||
|
|
||||||
|
|
||||||
|
### Ocean integration
|
||||||
|
Your "Mining Pool username" is just the onchain withdrawal address that you specify when pointing your miners at Ocean.
|
||||||
|
|
Loading…
Reference in a new issue