QPQ-AG/gmhive_client
9
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Some README edits.

Browse Source 
A typo, an expansion for (interested) laypeople, and a `\n` escape code.
This commit is contained in:
Jarvis Carroll 2025-05-29 16:13:28 +10:00
parent 25e5a11669
commit 51eca9c6f6
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -42,7 +42,7 @@ By default, the Hive client looks for a configuration file named
A specific configuration file can be identified using the OS environment
variable `GMHIVE_CLIENT_CONFIG`.
On invocation, indivitual configuration items can be set in one of two ways:
On invocation, individual configuration items can be set in one of two ways:
### OS environment variable overrides
@ -73,10 +73,14 @@ zx run uwiger-gmhive_client -gmhc pubkey ak_2Dfwyb...
### Considerations
The values for `pool_admin` and `pool` should be left alone. The configuration
item `"network"` (`"testnet"` or `"mainnet"`, where `"mainnet"` is default) instructs
the application to choose suitable defaults.
The values for `pool_admin` and `pool` should be left alone. The `"network"`
configuration item is special. Its default value is `"mainnet"`, which
indicates that the client should connect to
[gajumining.com](https://gajumining.com) to find the hive server, but by
changing its value to `"testnet"`, (or to other networks in the future,) not
only does this inform the client of the network for which the client should
mine, but it also changes what URL the client will use to find the hive
server. (For `"testnet"` this will be `"test.gajumining.com"`.)
## JSON Schema
@ -170,7 +174,7 @@ the application to choose suitable defaults.
"properties": {
"executable": {
"default": "mean29-generic",
"description": "Executable binary of the worker. Can be a fully qualified path, \nbut the software may apply default logic to locate a plain basename.",
"description": "Executable binary of the worker. Can be a fully qualified path, but the software may apply default logic to locate a plain basename.",
"type": "string"
},
"extra_args": {