Merge pull request #131 from tnull/2024-02-align-rustfmt

[ldk-sample] / README.md

diff --git a/README.md b/README.md
index 5b42054f191c5d9083d6c961ee13dfd153e00edd..27995932604c80c4b2902fa9700424a6d9e31d5e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,17 +3,17 @@ Sample node implementation using LDK.
 
 ## Installation
 ```
-git clone git@github.com:lightningdevkit/ldk-sample.git
+git clone https://github.com/lightningdevkit/ldk-sample
 ```
 
 ## Usage
 ```
 cd ldk-sample
-cargo run <bitcoind-rpc-username>:<bitcoind-rpc-password>@<bitcoind-rpc-host>:<bitcoind-rpc-port> <ldk_storage_directory_path> [<ldk-peer-listening-port>] [bitcoin-network] [announced-listen-addr announced-node-name]
+cargo run <bitcoind-rpc-username>:<bitcoind-rpc-password>@<bitcoind-rpc-host>:<bitcoind-rpc-port> <ldk_storage_directory_path> [<ldk-peer-listening-port>] [<bitcoin-network>] [<announced-node-name>] [<announced-listen-addr>]
 ```
 `bitcoind`'s RPC username and password likely can be found through `cat ~/.bitcoin/.cookie`.
 
-`bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`.
+`bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`, and `signet`.
 
 `ldk-peer-listening-port`: defaults to 9735.