From 703c6929f048d7c04827fdeba111e98c88ba253a Mon Sep 17 00:00:00 2001 From: Michael Bumann Date: Mon, 4 Mar 2019 20:20:05 +0100 Subject: [PATCH] Add note about default options --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 83c566d..43156de 100644 --- a/README.md +++ b/README.md @@ -76,13 +76,15 @@ The Lnrpc::Client constructor allows the following options: * credentials: - `credentials` : the credentials data as string - - `credentials_path` : the path to a credentials file (tls.cert) as string + - `credentials_path` : the path to a credentials file (tls.cert) as string (default: `"#{LND_HOME_DIR}/tls.cert"` ) * macaroon: - `macaroon` : the macaroon as hex string - - `macaroon_path` : the path to the macaroon file created by lnd as string + - `macaroon_path` : the path to the macaroon file created by lnd as string (default: `"#{LND_HOME_DIR}/data/chain/bitcoin/mainnet/admin.macaroon"`) * address: - - `address` : lnd address as string. format: address:port, e.g. default: localhost:10009 + - `address` : lnd address as string. format: address:port, e.g. localhost:10009 (default) +If no credentials or no macaroon is provied defaults files are assumed in `ENV['LND_HOME'] || "~/.lnd"`. +A macaroon is required. ```ruby require 'lnrpc'