From 4fdaaa461d49b5aff1f0e898beb65ff04197c2a8 Mon Sep 17 00:00:00 2001 From: Rene Pickhardt Date: Sat, 4 May 2019 11:43:56 +0200 Subject: [PATCH] enhanced the README.md file added another community repo, a tutorial video for pypi lightning and in particular added instructions how to run and activate plugins. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b80c9f0..59aed02 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ Community curated plugins for c-lightning. +To install and activate a plugin you need to stop your lightningd and restart it with the `plugin` argument like this: + +``` +lightningd --plugin=/path/to/plugin/directory/plugin_file_name.py +``` + +where the `plugin_file_name.py` should be an executable (`chmod a+x plugin_file_name.py`) file and can be written in any programming language. + ## Available plugins | Name | Short description | @@ -21,12 +29,13 @@ Community curated plugins for c-lightning. ## More Plugins from the Community - https://github.com/conscott/c-lightning-plugins + - https://github.com/renepickhardt/c-lightning-plugin-collection ## Plugin Builder Resources - [Description of the plugin API][plugin-docs] - [C Plugin API][c-api] by @rustyrussell - - [Python Plugin API & RPC Client][python-api] ([PyPI][python-api-pypi]) by @cdecker + - [Python Plugin API & RPC Client][python-api] ([PyPI][python-api-pypi]) by @cdecker and [a video tutorial](https://www.youtube.com/watch?v=FYs1I-pCJIg) by @renepickhardt - [Go Plugin API & RPC Client][go-api] by @niftynei [pers-chans]: https://github.com/lightningd/plugins/tree/master/persistent-channels