Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dni committed Feb 25, 2024
1 parent 0b0f6d4 commit 0f0e4d7
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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`.

0 comments on commit 0f0e4d7

Please sign in to comment.