From 34f81103a4963a3fcfef35fc8ef492b5dd0dc3be Mon Sep 17 00:00:00 2001 From: Michael Schmoock Date: Mon, 13 May 2019 12:05:47 +0200 Subject: [PATCH] doc: remove duplicated installation instructions --- rebalance/README.md | 22 +++++++++++----------- sendinvoiceless/README.md | 14 ++++++++------ 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/rebalance/README.md b/rebalance/README.md index 32e7777..63ee5a2 100644 --- a/rebalance/README.md +++ b/rebalance/README.md @@ -1,24 +1,24 @@ # Rebalance plugin -This plugin moves liquidity between your channels using circular payments. +This plugin moves liquidity between your channels using circular payments: -The plugin can be started with `lightningd` by adding the following `--plugin` -option. As with any `lightningd` plugin, the file has to be executable. As -with any lightning python plugin, `pylightning` must be installed or in your -`PYTHONPATH` environment variable. -``` -lightningd --plugin=/path/to/plugins/rebalance.py -``` +## Installation -Once the plugin is active you can rebalance your channels liquidity by running: +For general plugin installation instructions see the repos main +[README.md](https://github.com/lightningd/plugins/blob/master/README.md#Installation) + + +## Usage + +Once the plugin is installed and active, you can use the `lightning-cli` to +rebalance channels like this: ``` lightning-cli rebalance outgoing_scid incoming_scid [msatoshi] [maxfeepercent] [retry_for] [exemptfee] ``` - -## Parameters +### Parameters - The `outgoing_scid` is the short_channel_id of the sending channel, - The `incoming_scid` is the short_channel_id of the receiving channel. diff --git a/sendinvoiceless/README.md b/sendinvoiceless/README.md index 6dbc295..0480d93 100644 --- a/sendinvoiceless/README.md +++ b/sendinvoiceless/README.md @@ -4,14 +4,14 @@ This plugin sends some msatoshis without needing to have an invoice from the receiving node. It uses circular payment: takes the money to the receiving node, pays in the form of routing fee, and brings some change back to close the circle. -The plugin can be started with `lightningd` by adding the following `--plugin` -option (adjusting the path to wherever the plugins are actually stored): -``` -lightningd --plugin=/path/to/plugin/sendinvoiceless.py -``` +## Installation -## Send money +For general plugin installation instructions see the repos main +[README.md](https://github.com/lightningd/plugins/blob/master/README.md#Installation) + + +## Usage Once the plugin is active you can send payment by running: ``` @@ -33,6 +33,7 @@ only be an integer. For a detailed explanation of the optional parameters, see also the manpage of the `pay` plugin: `lightning-pay(7)` + ## List payments If you want to check if you got paid by using this method, you can call this: @@ -48,6 +49,7 @@ NOTE: The plugin currently does not use a database, so it can only assume fees have not changed in the past. It will also apply default fees for already forgotten channels. In both cases result can be slightly off by the changed fee. + ## Weaknesses This is kind of hack with some downsides: - The route is twice as long because of the circular payment. This will increase fees and failure probability.