Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
michael1011 committed Jun 28, 2024
1 parent c1fa08a commit 6d9c12d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# covclaim

This is a daemon that connects to Elements via RPC and ZMQ and watches the chain for claimable covenants of Boltz reverse swaps and broadcasts them.
This is a daemon that connects to Elements via RPC and ZMQ or an Esplora REST API and watches the chain for claimable
covenants of Boltz swaps and broadcasts them.

## Building

The latest stable version of Rust is required to build covclaim.

```bash
cargo build --release
```

## Configuration

Expand Down

0 comments on commit 6d9c12d

Please sign in to comment.