Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #26

Merged
merged 1 commit into from
Feb 25, 2024
Merged

chore: update readme #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
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`.
Loading