improve help text for karlsend-address arg

- add missing devnet arg in readme
Leon1777 · Aug 25, 2024 · d3a721a · d3a721a
1 parent 79b5fff
commit d3a721a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -75,9 +75,10 @@ OPTIONS:
         --opencl-workload <OPENCL_WORKLOAD>                Ratio of nonces to GPU possible parrallel run in OpenCL [default: 512]
         --opencl-workload-absolute                         The values given by workload are not ratio, but absolute number of nonces in OpenCL [default: false]
     -p, --port <PORT>                                      karlsend port [default: Mainnet = 42110, Testnet = 42210, Devnet = 42610]
-    -s, --karlsend-address <karlsend_ADDRESS>              The IP address, pool address, or node address of the karlsend instance [default: 127.0.0.1]
+    -s, --karlsend-address <karlsend_ADDRESS>              IP, pool, or node address of the Karlsend instance. Use stratum+tcp:// for stratum or grpc:// for Karlsend (default: grpc://127.0.0.1)
     -t, --threads <NUM_THREADS>                            Amount of CPU miner threads to launch [default: 0]
         --testnet                                          Use testnet instead of mainnet [default: false]
+        --devnet                                           Use devnet instead of mainnet [default: false]
 ```
 
 To start mining, you just need to run the following:

diff --git a/src/cli.rs b/src/cli.rs
@@ -16,7 +16,7 @@ pub struct Opt {
         short = 's',
         long = "karlsend-address",
         default_value = "127.0.0.1",
-        help = "The IP address, pool address, or node address of the karlsend instance"
+        help = "Specify the IP, pool, or node address of the Karlsend instance. Use stratum+tcp:// for stratum or grpc:// for Karlsend (default: grpc://127.0.0.1)"
     )]
     pub karlsend_address: String,