X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=27995932604c80c4b2902fa9700424a6d9e31d5e;hb=HEAD;hp=5dda263e31da6b421623d87ebaa0c47e8e2a2876;hpb=d9e9c01d33f291cf4846c0406a3e00c9ecbd543d;p=ldk-sample

diff --git a/README.md b/README.md
index 5dda263..2799593 100644
--- a/README.md
+++ b/README.md
@@ -3,20 +3,24 @@ 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]
+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.
 
+`announced-listen-addr` and `announced-node-name`: default to nothing, disabling any public announcements of this node.
+`announced-listen-addr` can be set to an IPv4 or IPv6 address to announce that as a publicly-connectable address for this node.
+`announced-node-name` can be any string up to 32 bytes in length, representing this node's alias.
+
 ## License
 
 Licensed under either: