Skip to content

Commit eb26494

Browse files
authored
payjoin-cli: Update README nigiri install instructions (payjoin#682)
2 parents a9b461a + 21648af commit eb26494

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

payjoin-cli/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `payjoin-cli`
22

3-
## A command-line payjoin client for [Bitcoin Core](https://github.com/bitcoin/bitcoin?tab=readme-ov-file) in Rust.
3+
## A command-line payjoin client for [Bitcoin Core](https://github.com/bitcoin/bitcoin?tab=readme-ov-file) in Rust
44

55
`payjoin-cli` is the reference implementation for the payjoin protocol, written using the [Payjoin Dev Kit](https://payjoindevkit.org).
66

@@ -17,15 +17,18 @@ Independent audit is welcome.
1717

1818
## Quick Start
1919

20-
Here's a minimal payjoin example using `payjoin-cli` with the `v2` feature connected to `bitcoind` on [regtest](https://developer.bitcoin.org/examples/testing.html#regtest-mode). This example uses [`nigiri`](https://github.com/vulpemventures/nigiri) to setup a regtest environment.
20+
Here's a minimal payjoin example using `payjoin-cli` with the `v2` feature connected to `bitcoind` on [regtest](https://developer.bitcoin.org/examples/testing.html#regtest-mode). This example uses [`nigiri`](https://github.com/vulpemventures/nigiri) to setup a regtest environment.
2121

2222
Payjoin `v2` allows for transactions to be completed asynchronously. Thus the sender and receiver do not need to be online at the same time to payjoin. Learn more about how `v2` works [here](https://payjoin.org/docs/how-it-works/payjoin-v2-bip-77).
2323

24-
To get started, install `nigiri`. Payjoin requires the sender and receiver each to have spendable [UTXOs](https://www.unchained.com/blog/what-is-a-utxo-bitcoin), so we'll create two wallets and fund each.
24+
To get started, install `nigiri` and [`docker`](https://www.docker.com/get-started). Payjoin requires the sender and receiver each to have spendable [UTXOs](https://www.unchained.com/blog/what-is-a-utxo-bitcoin), so we'll create two wallets and fund each.
2525

2626
```sh
27-
cargo install nigiri
27+
# Download nigiri and check install succeeded
28+
curl https://getnigiri.vulpem.com | bash
29+
nigiri --version
2830

31+
# Create two regtest wallets
2932
nigiri rpc createwallet "sender"
3033
nigiri rpc createwallet "receiver"
3134

@@ -127,7 +130,6 @@ See the
127130
[example.config.toml](https://github.com/payjoin/rust-payjoin/blob/fde867b93ede767c9a50913432a73782a94ef40b/payjoin-cli/example.config.toml)
128131
for inspiration.
129132

130-
131133
### Asynchronous Operation
132134

133135
Sender and receiver state is saved to a database in the directory from which `payjoin-cli` is run, called `payjoin.sled`. Once a send or receive session is started, it may resume using the `resume` argument if prior payjoin sessions have not yet complete.

0 commit comments

Comments
 (0)