From 0f0e4d7dd4cfc238e329989910c7caf07e950557 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?dni=20=E2=9A=A1?= Date: Sun, 25 Feb 2024 10:24:24 +0100 Subject: [PATCH] update readme --- README.md | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b163f65..d984a10 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ # Boltz Python Client -Boltz Reference Client in Python, implementing mainchain and liquid submarine swaps. Used by e.g. https://github.com/lnbits/boltz. +Boltz Client in Python, implementing mainchain and liquid submarine swaps. Used by e.g. https://github.com/lnbits/boltz. + + +# CLI +```console +$ boltz --help +Usage: boltz [OPTIONS] COMMAND [ARGS]... + + Python CLI of boltz-client-python, enjoy submarine swapping. :) + +Options: + --help Show this message and exit. + +Commands: + calculate-swap-send-amount calculate the amount of the invoice you... + claim-reverse-swap claims a reverse swap + create-reverse-swap create a reverse swap + create-reverse-swap-and-claim create a reverse swap and claim + create-swap create a swap boltz will pay your... + refund-swap refund a swap + show-pairs show pairs of possible assets to swap + swap-status get swap status retrieves the status of... +``` +install the latest release from [PyPI](https://pypi.org/project/boltz-client) via `pip install boltz_client`. + + +# development ## installing ```console @@ -22,5 +48,3 @@ chmod +x regtest ```console poetry run pytest ``` - -Or install the latest release from [PyPI](https://pypi.org/project/boltz-client) via `pip install boltz_client`.