Skip to content

Commit 29388a1

Browse files
authored
Link to crates.io to get $VERSION (payjoin#608)
Adds a link in the `payjoin-cli` README to the `payjoin-cli` crates.io page to allow anyone following the README instructions to easily find the latest usable version. I suppose we could also use this url to be even more explicit if we choose: [https://crates.io/crates/payjoin-cli/versions](https://crates.io/crates/payjoin-cli/versions). Also changes "payjoin-cli" references to render as `payjoin-cli` (an opinionated change I'll admit). Closes payjoin#595
2 parents 8f68d8d + 00afa40 commit 29388a1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

payjoin-cli/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# payjoin-cli
1+
# `payjoin-cli`
22

3-
## A command-line payjoin client for bitcoind in rust
3+
## A command-line payjoin client for bitcoind in Rust
44

55
The `payjoin-cli` client enables sending and receiving of [BIP 78 Payjoin V1](https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki) and [Draft BIP Payjoin V2](https://github.com/bitcoin/bips/pull/1483) transactions. By default it supports Payjoin V1, and the `v2` feature sends and receives both since the protocol is backwards compatible. The implementation is built on [Payjoin Dev Kit](https://payjoindevkit.org).
66

77
While this code and design has had significant testing, it is still alpha-quality experimental software. Use at your own risk.
88
Independent audit is welcome.
99

10-
## Install payjoin-cli
10+
## Install `payjoin-cli`
1111

1212
```console
1313
cargo install payjoin-cli --version $VERSION
1414
```
1515

16-
where `$VERSION` is the latest version of the payjoin-cli you wish to install.
16+
where `$VERSION` is the [latest version](https://crates.io/crates/payjoin-cli) of the `payjoin-cli` you wish to install.
1717

1818
Get a list of commands and options:
1919

2020
```console
2121
payjoin-cli --help
2222
```
2323

24-
Either pass config options from cli, or manually edit a `config.toml` file within directory you run payjoin-cli from.
24+
Either pass config options from cli, or manually edit a `config.toml` file within directory you run `payjoin-cli` from.
2525
Configure it like so:
2626

2727
```toml
@@ -35,7 +35,7 @@ Your configuration details will vary, but you may use this as a template.
3535

3636
## Test Payjoin 2
3737

38-
### Install payjoin-cli with the V2 feature
38+
### Install `payjoin-cli` with the V2 feature
3939

4040
```console
4141
cargo install payjoin-cli --version $VERSION --features v2
@@ -57,7 +57,7 @@ ohttp_relay="https://pj.bobspacebkk.com"
5757

5858
### Asynchronous Operation
5959

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

6262
```console
6363
payjoin-cli resume
@@ -76,7 +76,7 @@ file. 18443 is the default. This can be set like so:
7676
rpcport = 18443
7777
```
7878

79-
From the directory you'll run payjoin-cli, assuming "boom" is the name of the receiving wallet, 18443 is the rpc port, and you wish to request 10,000 sats run:
79+
From the directory you'll run `payjoin-cli`, assuming "boom" is the name of the receiving wallet, 18443 is the rpc port, and you wish to request 10,000 sats run:
8080

8181
```console
8282
RUST_LOG=debug cargo run --features=_danger-local-https -- -r "http://localhost:18443/wallet/boom" receive 10000
@@ -93,7 +93,7 @@ BITCOIN:BCRT1QCJ4X75DUNY4X5NAWLM3CR8MALM9YAUYWWEWKWL?amount=0.00010&pj=https://l
9393

9494
### Test Send
9595

96-
Create a "sender" directory within payjoin-cli. Open a new terminal window and navigate to this directory.
96+
Create a "sender" directory within `payjoin-cli`. Open a new terminal window and navigate to this directory.
9797

9898
Note: A wallet cannot payjoin with itself, one needs separate wallets.
9999

0 commit comments

Comments
 (0)