You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
Closespayjoin#595
Copy file name to clipboardExpand all lines: payjoin-cli/README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,27 @@
1
-
# payjoin-cli
1
+
# `payjoin-cli`
2
2
3
-
## A command-line payjoin client for bitcoind in rust
3
+
## A command-line payjoin client for bitcoind in Rust
4
4
5
5
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).
6
6
7
7
While this code and design has had significant testing, it is still alpha-quality experimental software. Use at your own risk.
8
8
Independent audit is welcome.
9
9
10
-
## Install payjoin-cli
10
+
## Install `payjoin-cli`
11
11
12
12
```console
13
13
cargo install payjoin-cli --version $VERSION
14
14
```
15
15
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.
17
17
18
18
Get a list of commands and options:
19
19
20
20
```console
21
21
payjoin-cli --help
22
22
```
23
23
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.
25
25
Configure it like so:
26
26
27
27
```toml
@@ -35,7 +35,7 @@ Your configuration details will vary, but you may use this as a template.
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.
61
61
62
62
```console
63
63
payjoin-cli resume
@@ -76,7 +76,7 @@ file. 18443 is the default. This can be set like so:
76
76
rpcport = 18443
77
77
```
78
78
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:
80
80
81
81
```console
82
82
RUST_LOG=debug cargo run --features=_danger-local-https -- -r "http://localhost:18443/wallet/boom" receive 10000
0 commit comments