Forward HTLCs after a timeout and a few other cleanups

[ldk-sample] / README.md

diff --git a/README.md b/README.md
index 6358f4ff81e5cac1ce012d546bd7637983cbd8ab..4b9e99a892569c031c362f2e4c6c3ade98fa3184 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
 # ldk-sample
-sample node implementation using LDK
+Sample node implementation using LDK.
+
+## Installation
+```
+git clone git@github.com:lightningdevkit/ldk-sample.git
+```
+
+## 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]
+```
+`bitcoin-network`: defaults to `testnet`. Options: `testnet`, `regtest`.
+
+`ldk-peer-listening-port`: defaults to 9735.
 
 ## License