Skip to content

Commit 36b1554

Browse files
Update payjoin-cli README.md
1 parent 3976ba1 commit 36b1554

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

payjoin-cli/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ cargo install payjoin-cli --version $VERSION
4444

4545
where `$VERSION` is the [latest version](https://crates.io/crates/payjoin-cli).
4646

47-
Next, create a directory for the sender & receiver and create a `config.toml` file for each:
47+
Next, create a directory for the sender & receiver and create a file called `config.toml` for each. This file provides the information required for `payjoin-cli` to connect to your node and, for `v2`, to know which Payjoin Directory and OHTTP Relay to use.
4848

4949
```sh
5050
mkdir sender receiver
5151
touch sender/config.toml receiver/config.toml
5252
```
5353

54-
Edit the `config.toml` files. Note that the `v2` feature requires a payjoin directory server and OHTTP relay.
54+
Edit the `config.toml` files.
5555

5656
```toml
5757
# sender/config.toml
@@ -98,7 +98,8 @@ receiver/payjoin-cli receive 10000
9898
This will output a [bitcoin URI](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) containing the receiver's address, amount, payjoin directory, and other session information the client needs. For example:
9999

100100
```sh
101-
bitcoin:tb1qfttmt4z68cfyn2z25t3dusp03rq6gxrucfxs5a?amount=0.0001&pj=HTTPS://PAYJO.IN/EUQKYLU92GC6U%23RK1QFWVXS2LQ2VD4T6DUMQ0F4RZQ5NL9GM0EFWVHJZ9L796L20Z7SL3J+OH1QYP87E2AVMDKXDTU6R25WCPQ5ZUF02XHNPA65JMD8ZA2W4YRQN6UUWG+EX10T57UE```
101+
bitcoin:tb1qfttmt4z68cfyn2z25t3dusp03rq6gxrucfxs5a?amount=0.0001&pj=HTTPS://PAYJO.IN/EUQKYLU92GC6U%23RK1QFWVXS2LQ2VD4T6DUMQ0F4RZQ5NL9GM0EFWVHJZ9L796L20Z7SL3J+OH1QYP87E2AVMDKXDTU6R25WCPQ5ZUF02XHNPA65JMD8ZA2W4YRQN6UUWG+EX10T57UE
102+
```
102103

103104
Note that the session can be paused by pressing `Ctrl+C`. The receiver can come back online and resume the session by running `payjoin-cli resume` again, and the sender may do a `send` against it while the receiver is offline.
104105

@@ -122,7 +123,7 @@ Congratulations! You've completed a version 2 payjoin, which can be used for che
122123

123124
Config options can be passed from the command line, or manually edited in a `config.toml` file within the directory you run `payjoin-cli` from.
124125

125-
see the
126+
See the
126127
[example.config.toml](https://github.com/payjoin/rust-payjoin/blob/fde867b93ede767c9a50913432a73782a94ef40b/payjoin-cli/example.config.toml)
127128
for inspiration.
128129

0 commit comments

Comments
 (0)