Skip to content
This repository was archived by the owner on Mar 8, 2024. It is now read-only.

Commit 0685b6d

Browse files
committed
add docker details to README
1 parent b8682b4 commit 0685b6d

File tree

2 files changed

+32
-49
lines changed

2 files changed

+32
-49
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Based on the Typescript PayID [Utils](https://github.com/payid-org/utils) librar
1010
In order to use the CLI, both [node](https://nodejs.org/en/download/) and
1111
[npm](https://docs.npmjs.com/downloading-and-installing-packages-locally) must be installed first.
1212

13+
Alternatively, the CLI can be run as a Docker container, though commands that store information
14+
locally will only persist for the duration of the container.
15+
1316
## Installation
1417

1518
To install the PayID CLI, run the command:
@@ -18,6 +21,14 @@ To install the PayID CLI, run the command:
1821
npm install -g @payid-org/payid-cli
1922
```
2023

24+
This will install the CLI as a global npm module and link it as a `payid` executable
25+
(typically under /usr/local/bin/payid).
26+
27+
Alternatively, install and run via Docker:
28+
```
29+
docker run xpring/payid-cli
30+
```
31+
2132
## Interactive vs single command mode
2233

2334
CLI can be run in interactive mode or non-interactive (single command) mode.

package-lock.json

Lines changed: 21 additions & 49 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)