Skip to content

Commit

Permalink
docs: add tip command inside the docs
Browse files Browse the repository at this point in the history
Signed-off-by: Vincenzo Palazzo <[email protected]>
  • Loading branch information
vincenzopalazzo committed Feb 6, 2024
1 parent 832bd24 commit 5c14086
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/docs-book/src/support-coffee.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: <bolt12 invoice>
```

9 changes: 9 additions & 0 deletions docs/docs-book/src/using-coffee.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <plugin_name> <millisatoshi>
```

------
## Running coffee as a server

To run Coffee as a server, you can use the `coffee_httpd` binary.
Expand Down

0 comments on commit 5c14086

Please sign in to comment.