Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add 'how to run' instruction to readme #86

Merged
merged 1 commit into from
May 15, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,20 @@ make a customization, these are some configuration options:
- `bitcoin-rpcpassword`: Bitcoin core RPC password for authentication.
- `bitcoin-fallback-client`: Bitcoin fallback client, in the case one of the client fails, the plugin use another backend for the request.

## How to run

Once plugin is successfully installed, you can simply run "lightningd" and plugin will start. However, you're supposed to run "lightningd" with "--disable-plugin bcli" option.

```
lightningd --network=<network-name> --disable-plugin bcli
```

for eg.

```
lightningd --network=testnet --disable-plugin bcli
```

## BIP 157 support

This plugin allow the support of the BIP 157 [Client Side Block Filtering](https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki) in core lightning
Expand Down
Loading