From 64004b6baf69400382ee118d2a05bbcbc0514788 Mon Sep 17 00:00:00 2001 From: Vincenzo Palazzo Date: Sun, 30 Jul 2023 08:46:07 +0200 Subject: [PATCH] docs: add tip command inside the docs Signed-off-by: Vincenzo Palazzo --- docs/docs-book/src/support-coffee.md | 22 ++++++++++++++++++++++ docs/docs-book/src/using-coffee.md | 9 +++++++++ 2 files changed, 31 insertions(+) diff --git a/docs/docs-book/src/support-coffee.md b/docs/docs-book/src/support-coffee.md index 59f96a23..27b92f6e 100644 --- a/docs/docs-book/src/support-coffee.md +++ b/docs/docs-book/src/support-coffee.md @@ -41,3 +41,25 @@ itself. With some craziness will be also possible to manage core lightning itsel Please if you feel that additional meta information needs to be specified open an issue https://github.com/coffee-tools/coffee/issues + +## Tipping + +While there are possibility to tipping anything on lightning, there is any solution to tipping a core lightning plugin +developer. So with coffee as developer you can define a BOLT 12 invoice that allow the developer of the plugin +to receive tips. So, the developer of the plugin should define a coffee manifest that specify the `tipping` info. + +An example can be: + +```yaml +--- +plugin: + name: btcli4j + version: 0.0.1 + lang: java + install: | + sh -C ./gradlew createRunnableScript + main: btcli4j-gen.sh +tipping: + bolt12: +``` + diff --git a/docs/docs-book/src/using-coffee.md b/docs/docs-book/src/using-coffee.md index 2e5558a4..a23d367e 100644 --- a/docs/docs-book/src/using-coffee.md +++ b/docs/docs-book/src/using-coffee.md @@ -159,6 +159,15 @@ Additionally, if you wish to perform a verification of coffee without making any coffee nurse --verify ``` _________ +### Tipping a plugin in Bitcoin + +> ✅ Implemented + +``` +coffee tip +``` + +------ ## Running coffee as a server To run Coffee as a server, you can use the `coffee_httpd` binary.