X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=README.md;h=5b42054f191c5d9083d6c961ee13dfd153e00edd;hb=e87a9e18f6739988b93b6bc38c1ae178c0bdaeb8;hp=4b9e99a892569c031c362f2e4c6c3ade98fa3184;hpb=80916829ec20eb8a510462e765a03c3ed051f2e0;p=ldk-sample diff --git a/README.md b/README.md index 4b9e99a..5b42054 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,21 @@ git clone git@github.com:lightningdevkit/ldk-sample.git ## Usage ``` cd ldk-sample -cargo run :@: [] [bitcoin-network] +cargo run :@: [] [bitcoin-network] [announced-listen-addr announced-node-name] ``` +`bitcoind`'s RPC username and password likely can be found through `cat ~/.bitcoin/.cookie`. + `bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`. `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 of +Licensed under either: * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)