Skip to content

Commit 897421c

Browse files
committed
docs(readme): improve writing
1 parent 985ad07 commit 897421c

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ It provides the following in a single binary:
1515

1616
pago encrypts passwords with one or more public keys using [age](https://github.com/FiloSottile/age) (pronounced with a hard "g").
1717
The public keys are called "recipients".
18-
A private key matching any of the recipient public keys can decrypt the password.
18+
A private key matching one of the recipient public keys can decrypt the password.
1919
The private keys are called "identities".
2020
The file with the identities is encrypted with a password, also using age.
2121

2222
pago implements an agent like [ssh-agent](https://en.wikipedia.org/wiki/Ssh-agent) or [gpg-agent](https://www.gnupg.org/documentation/manuals/gnupg/Invoking-GPG_002dAGENT.html).
23-
The agent caches the identities used to decrypt the passwords.
23+
The agent caches the identities.
2424
This mean you don't have to enter the master password again during a session.
2525
pago starts the agent the first time you enter the master password.
2626
You can also start and stop the agent manually.
2727

2828
The pago password store format is compatible with [passage](https://github.com/FiloSottile/passage).
2929
It has the following differences:
3030

31-
- The pago directory is located in `${XDG_DATA_HOME}/pago/`, while passage uses `~/.passage/`
31+
- The pago directory is located at `${XDG_DATA_HOME}/pago/`, while passage uses `~/.passage/`
3232
- passage supports an encrypted or an unencrypted identities file; pago only supports encrypted
3333

3434
## Threat model
@@ -40,12 +40,12 @@ An attacker who gets ahold of your pago directory but not the master password sh
4040
My primary password manager is [KeePassXC](https://github.com/keepassxreboot/keepassxc).
4141
I use a secondary password manager to access a subset of secrets in cron jobs and scripts and on headless remote systems.
4242

43-
For a time, I used [`pass`](https://www.passwordstore.org/) for this.
43+
I used [`pass`](https://www.passwordstore.org/) for this for a time.
4444
While I liked the design of `pass` and found it pleasant to use, I didn't like setting up GPG on a new system.
4545
I went looking for a `pass` replacement based on age
4646
because I had replaced GPG with age for encrypting files.
47-
The following is the shortlist of password managers I compiled before I decided to work on pago.
48-
It includes an explanation for why I didn't adopt them.
47+
The following is the late-2024 shortlist of password managers I compiled before I decided to work on pago.
48+
It includes explanations for why I didn't adopt them.
4949

5050
First, I needed the identities encrypted at rest and usable without reentering the password.
5151
This ruled out [passage](https://github.com/FiloSottile/passage), which had no an agent, and [pa](https://github.com/biox/pa), which didn't support encryption for the identities file.
@@ -59,20 +59,19 @@ For more options, see ["Awesome age"](https://github.com/FiloSottile/awesome-age
5959
## History
6060

6161
pago is a heavily modified fork of [pash](https://github.com/dylanaraps/pash) (archived).
62-
It has been ported from POSIX shell to Tcl to Go.
63-
In the middle of this, it switched from [GPG](https://gnupg.org/) to age.
62+
It has been ported from POSIX shell to Tcl to Go and from [GPG](https://gnupg.org/) to age.
6463

6564
## Installation
6665

67-
You will need Go 1.22 to install pago.
66+
You will need Go 1.22 or later to install pago.
6867
Once Go is installed on your system, run the following command:
6968

7069
```
7170
go install github.com/dbohdan/pago@master
7271
```
7372

7473
Shell completion files for Bash and fish are available in [`completions/`](completions/).
75-
To install completions fish, run `install.fish`.
74+
To install completions for fish, run `install.fish`.
7675

7776
## Supported platforms
7877

0 commit comments

Comments
 (0)